spadinastan/README.md

# spadinaistan

## Quoi?

Spadinaistan is my personal cloud, which runs on an old laptop in my office. This code isn't intended to be used by
anyone else.

## Getting started

Use `. bootstrap.sh` to set up Task.

Once this is done, `task -l` will outline all available commands.

## Configuration

### Environment provided to tasks

The task runner requires a `env.yml` file to exist at the top level. This should define a few global variables that are
specific to the environment:

```
version: '3'

env:
    # Path to the application data storage root.
    APP_DATA_DIR: ...
    # Prefix to all container names.
    CONTAINER_NAME_PREFIX: ...
    # Path to the app-specific dotenv files.
    ENV_FILE_DIR: ...
    # Name of the network associated with the tunnel exposing services.
    SHARED_NETWORK_NAME: ...
    # Path to the storage root.
    STORAGE_DIR: ...
```

The `env.yml` file is ignored by version-control.

### Image versions

When building and starting images, images are tagged with either the release version (if on a commit that's tagged with
a release) or a dev tag that includes the hash (i.e. `dev-<commit-hash>`).
feat: plex setup (#1) 2022-07-29 21:59:21 +00:00			`# spadinaistan`

refactor: hoist start/stop/restart to top-level (#21) * refactor: hoist start/stop/restart to top-level * docs: README updates 2023-05-28 18:39:27 +00:00			`## Quoi?`

			`Spadinaistan is my personal cloud, which runs on an old laptop in my office. This code isn't intended to be used by`
			`anyone else.`

chore: clean up unneeded bootstrap 2022-12-03 20:52:06 +00:00			`## Getting started`

chore(deadcode): clean up pyinvoke+pyinfra logic, python venv 2023-12-15 20:52:02 +00:00			Use `. bootstrap.sh` to set up Task.
refactor: hoist start/stop/restart to top-level (#21) * refactor: hoist start/stop/restart to top-level * docs: README updates 2023-05-28 18:39:27 +00:00
chore(deadcode): clean up pyinvoke+pyinfra logic, python venv 2023-12-15 20:52:02 +00:00			Once this is done, `task -l` will outline all available commands.
feat(services): bookstack (#33) * feat(bookstack): working example bookstack instance * build(taskfiles): add Taskfile to handle start+stop * fix: ensure that network exists without erroring * chore(git): ignore Task bin * docs: notes on volumes, task commands * build(taskfiles): add build command, centralized user-supplied env * refactor(taskfiles): split away internal tasks * refactor(taskfiles): move environment variables into shared env.yml 2023-12-15 17:40:14 +00:00
			`## Configuration`

			`### Environment provided to tasks`

			The task runner requires a `env.yml` file to exist at the top level. This should define a few global variables that are
			`specific to the environment:`

			```
			`version: '3'`

			`env:`
			`# Path to the application data storage root.`
			`APP_DATA_DIR: ...`
			`# Prefix to all container names.`
			`CONTAINER_NAME_PREFIX: ...`
			`# Path to the app-specific dotenv files.`
			`ENV_FILE_DIR: ...`
			`# Name of the network associated with the tunnel exposing services.`
			`SHARED_NETWORK_NAME: ...`
feat(plex): move Plex setup to task model fix: ports published for plex fix: Dockerfile name 2023-12-15 20:23:39 +00:00			`# Path to the storage root.`
			`STORAGE_DIR: ...`
feat(services): bookstack (#33) * feat(bookstack): working example bookstack instance * build(taskfiles): add Taskfile to handle start+stop * fix: ensure that network exists without erroring * chore(git): ignore Task bin * docs: notes on volumes, task commands * build(taskfiles): add build command, centralized user-supplied env * refactor(taskfiles): split away internal tasks * refactor(taskfiles): move environment variables into shared env.yml 2023-12-15 17:40:14 +00:00			```

			The `env.yml` file is ignored by version-control.
feat: update all services to tag images with release or dev+hash docs: mention version-tagging 2023-12-16 04:52:03 +00:00
			`### Image versions`

			`When building and starting images, images are tagged with either the release version (if on a commit that's tagged with`
			a release) or a dev tag that includes the hash (i.e. `dev-<commit-hash>`).