dan/docker-compose
1
0
Fork 0
mirror of https://github.com/danbulant/docker-compose synced 2026-05-19 20:38:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add details of execPath option

Browse source
This commit is contained in:
Michael James 2021-05-06 22:12:39 -06:00 committed by Alexander Zeitler
parent 58f09f4c74
commit 44f0e9eeb3
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -74,6 +74,7 @@ compose.exec('node', 'npm install', { cwd: path.join(__dirname) })
`docker-compose` accepts these params:
* `cwd {string}`: mandatory folder path to the `docker-compose.yml`
* `execPath {string}`: optional path to docker-compose exec in case it's not located in $PATH `/path/to/docker-compose`
* `config {(string|string[])}`: custom and/or multiple yml files can be specified (relative to `cwd`)
* `configAsString {string}`: configuration can be provided as is, instead of relying on a file. In case `configAsString` is provided `config` will be ignored.
* `[log] {boolean}`: optional setting to enable console logging (output of `docker-compose` `stdout`/`stderr` output)