diff --git a/README.md b/README.md index 7395b49..8664166 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,15 @@ See `requirements.txt` 2. Adapt `config.yml.example` to your needs and save it as `config.yml` 3. Run `dc-ops` from the shell or from a cron job +## Configuration Options +- `loglevel`: (optional) define loglevel. Defaults to "INFO" if not set. +- `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. + - `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. + - `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`. + ## Detailed process For each enabled stack in the config file, the following process will be executed: