scripts/README.md

# scripts

_Utilities to manage the machine Spadinastan runs on._

## Setup

Python dependencies associated with the scripts can be installed via `./bootstrap.sh`, which provides a venv to run the
scripts in.

## Usage

Ensure that `go-task` is installed and `task -l`!

## System configuration

Scripts used by the `task` command will expect certain configuration files to exist on the system.

A file should exist at `/etc/opt/spadinastan/common.env` to define general root locations for where application data and media will be stored.

```
# /etc/opt/common.env

# Storage for application configuration volumes.
APP_DATA_DIR=...

# Storage for media owned by applications, such as downloads.
STORAGE_DIR=...
```

## Per-app configuration

Each application expects to find an environment file under `/etc/opt/spadinastan/<application>.env`. This is passed to the container as an envfile on start.

If the container doesn't expect anything, the file should still be present but empty.
Initial commit 2024-05-02 03:11:10 +00:00			`# scripts`

feat: volume backup script 2024-07-06 19:52:06 +00:00			`_Utilities to manage the machine Spadinastan runs on._`

			`## Setup`

			Python dependencies associated with the scripts can be installed via `./bootstrap.sh`, which provides a venv to run the
			`scripts in.`
feat: minimal func for start+stop+build 2024-05-09 04:27:20 +00:00
			`## Usage`

			Ensure that `go-task` is installed and `task -l`!
docs: document environment and application conf expectations 2024-05-09 04:38:42 +00:00
			`## System configuration`

			Scripts used by the `task` command will expect certain configuration files to exist on the system.

			A file should exist at `/etc/opt/spadinastan/common.env` to define general root locations for where application data and media will be stored.

			```
			`# /etc/opt/common.env`

			`# Storage for application configuration volumes.`
			`APP_DATA_DIR=...`

			`# Storage for media owned by applications, such as downloads.`
			`STORAGE_DIR=...`
			```

			`## Per-app configuration`

			Each application expects to find an environment file under `/etc/opt/spadinastan/<application>.env`. This is passed to the container as an envfile on start.

			`If the container doesn't expect anything, the file should still be present but empty.`