A companion for Docker Compose
Project description
Compose Companion
This is a little CLI tool created for my home server.
It aims to make it easy to configure and document scripts that should run before and/or after the server containers on docker compose go up or down.
Scrips File
The app will read the scripts from a yaml file in the following format:
# compose-companion.yaml
x-before-up:
sonarr:
- echo this will run before sonarr startup
- echo this too will run before sonarr startup, after the previous one
radarr:
- echo this will run before radarr startup
- echo this too will run before radarr startup, after the previous one
x-after-up:
sonarr:
- echo this will run after sonarr startup
- echo this too will run after sonarr startup, after the previous one
radarr:
- echo this will run after radarr startup
- echo this too will run after radarr startup, after the previous one
x-before-down:
sonarr:
- echo this will run before sonarr shutdown
- echo this too will run before sonarr shutdown, after the previous one
radarr:
- echo this will run before radarr shutdown
- echo this too will run before radarr shutdown, after the previous one
x-after-down:
sonarr:
- echo this will run after sonarr shutdown
- echo this too will run after sonarr shutdown, after the previous one
radarr:
- echo this will run after radarr shutdown
- echo this too will run after radarr shutdown, after the previous one
The container keys should match the ones from docker-compose.yaml
file.
The app will look for a file named compose-companion.yaml
on the folder it's first run, if that's not there it'll ask you to inform the file path manually.
As the top-level keys start with x-
, you can use the docker-compose.yaml
file itself, if you wish, and these settings will be properly ignored by docker compose.
Commands
For a list of command, run compose --help
or simply compose
.
For details on each command, run compose [command] --help
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for compose_companion-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f36c9aac78530e415455e2217dd91c1f998132d257e106ecebcb97a6ebbf7fcf |
|
MD5 | 873d55e8293d54927a873a94cdb0ac1b |
|
BLAKE2b-256 | ddf6242314e329784d89caea5387ae73c871c1e991e3f12270e47cfc8ffb6bf3 |