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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 905895352d948ca8fd8895c5a355b42f30b6f0b073a5a297dc3ce6ab0af4fa4c |
|
MD5 | dd0d382e8d257def59191fbd0f944d1a |
|
BLAKE2b-256 | 3fe8d34409439a6aaa9724b96432defd5df47903dbd395056a3a91726656732f |