From 76a8866c73fe9d3774a081d110ed52ea794a7c98 Mon Sep 17 00:00:00 2001 From: Aleksandr Volochnev Date: Sun, 10 Sep 2017 22:01:06 +0200 Subject: [PATCH] Updated README.md Improved description of configuration options of docker-compose class. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 2ba750e1d..4ae707628 100755 --- a/README.md +++ b/README.md @@ -425,6 +425,17 @@ class {'docker::compose': } ``` +When installing docker-compose, few additional options can be configured: + +```puppet +class {'docker::compose': + ensure => present, + version => '1.16.1', # Optional. An exact version of docker-compose to install. + install_path => '/usr/local/bin', # Optional. The directory to store docker-compose. + proxy => 'exampleproxy.com:9999' # A proxy server to use during installation. <[protocol://][user:password@]proxyhost[:port]> +} +``` + Here's an example. Given the following Compose file: ```yaml