spadinastan/scripts
1
0
Fork 0
Code Issues Wiki Activity Actions

docs: document environment and application conf expectations

Browse source
This commit is contained in:
Marc 2024-05-09 00:38:42 -04:00
parent 21b402d2bb
commit ba88c17f6a
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -5,3 +5,25 @@ _Quick and dirty utilities to build, start and stop services._
## Usage ## Usage
Ensure that `go-task` is installed and `task -l`! 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.