infrastructure/dc-ops
2
0
Fork 0
Code Issues 1 Pull requests Activity

doc: update config file help and reorder options

Browse source
This commit is contained in:
Sebastian Mark 2023-12-21 19:15:58 +01:00
parent b4ac46f925
commit 899b1f1c81
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -23,15 +23,15 @@ See `requirements.txt`
See `dc-ops --help` See `dc-ops --help`
## Configuration Options ## Configuration Options
- `self-update`: (optional) update this script on startup. Defaults to `false`.
- `loglevel`: (optional) define loglevel. Defaults to "INFO" if not set.
- `compose-opts`: (optional) define additional parameters to `docker compose up -d`.
- `stacks`: an array containing details for each repository. Each element is a dictionary containing the following keys: - `stacks`: an array containing details for each repository. Each element is a dictionary containing the following keys:
- `dir`: the directory of the repository on your local machine. - `dir`: the directory of the repository on your local machine.
- `compose-files`: (optional) array of paths (relative to `dir`) to docker-compose files. Uses `["docker-compose.yml"]` by default if not set. - `compose-files`: (optional) array of paths (relative to `dir`) to docker-compose files. Uses `["docker-compose.yml"]` by default if not set.
- `enabled`: (optional) `false` if this repository should be skipped. Defaults to `true` if not set. - `enabled`: (optional) `false` if this repository should be skipped. Defaults to `true` if not set.
- `pre`: (optional) a command to be run before `docker-compose up`, executed in `dir`. - `pre`: (optional) a command to be run before `docker compose up`, executed in `dir`.
- `post`: (optional) a command to be run after `docker-compose up`, executed in `dir`. - `post`: (optional) a command to be run after `docker compose up`, executed in `dir`.
- `compose-opts`: (optional) define additional parameters to `docker compose up -d`.
- `loglevel`: (optional) define loglevel. Defaults to "INFO" if not set.
- `self-update`: (optional) update this script on startup. Defaults to `false`.
## Detailed process ## Detailed process
For each enabled stack in the config file, the following process will be executed: For each enabled stack in the config file, the following process will be executed: