README.md in vagrant-docker-compose-0.0.8 vs README.md in vagrant-docker-compose-0.0.9
- old
+ new
@@ -36,10 +36,33 @@
```bash
docker-compose -f [yml] up -d
```
+### To install and run docker-compose, with multiple files, on `vagrant up`
+
+```ruby
+Vagrant.configure("2") do |config|
+ config.vm.box = "ubuntu/trusty64"
+
+ config.vm.provision :docker
+ config.vm.provision :docker_compose,
+ yml: [
+ "/vagrant/docker-compose-base.yml",
+ "/vagrant/docker-compose.yml",
+ ...
+ ],
+ run: "always"
+end
+```
+
+Equivalent to running:
+
+```bash
+docker-compose -f [yml-0] -f [yml-1] ... up -d
+```
+
### To install, rebuild and run docker-compose on `vagrant up`
```ruby
Vagrant.configure("2") do |config|
config.vm.box = "ubuntu/trusty64"
@@ -78,9 +101,10 @@
```
### Other configs
+* `yml` – one or more [Compose files](https://docs.docker.com/compose/compose-file/) (YAML), may be a `String` for a single file, or `Array` for multiple.
* `compose_version` – defaults to `1.5.0`.
* `project_name` – compose will default to naming the project `vagrant`.
* `executable` – the location the executable will be stored, defaults to `/usr/local/bin/docker-compose`.
* `options` - a `String` that's included as the first arguments when calling the docker-compose executable, you can use this to pass arbitrary options/flags to docker-compose, default to `nil`.
* `command_options` - a `Hash` of docker-compose commands to options, you can use this to pass arbitrary options/flags to the docker-compose commands, defaults to: `{ rm: "--force", up: "-d" }`.