Release version 0.4.1

webdevops · Oct 9, 2017 · 720b37a · 720b37a
1 parent d0e41c6
commit 720b37a
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -33,6 +33,20 @@ Deployment:
 - Rsync filters
 - Custom exec scripts (startup/finish) on local or remote machine (using SSH)
 
+Install
+=======
+
+The binary file can be found in the [project releases](./releases/).
+
+```
+DOWNLOAD_VERSION=0.4.1
+DOWNLOAD_OS=linux
+DOWNLOAD_ARCH=x64
+
+wget -O/usr/local/bin/gosync "https://github.com/webdevops/go-sync/releases/download/${DOWNLOAD_VERSION}/gosync-${DOWNLOAD_OS}-${DOWNLOAD_ARCH}"
+chmod +x /usr/local/bin/gosync
+```
+
 Help
 ====
 
@@ -89,3 +103,34 @@ Example
    -> executing >> Exec[Type:remote Workdir:/ Command:date]
 -> finished
 ```
+
+## Docker support
+
+Docker support
+==============
+
+Using the configuration ``connection.docker=configuration`` this command can be
+execued with docker containers. If the container id is passed the
+container is used without lookup using eg. `docker-compose`.
+
+**docker-compose:**
+
+*CONTAINER* is the name of the docker-compose container.
+
+| DSN style configuration                                             | Description                                                                                            |
+|:--------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------|
+| ``compose:CONTAINER``                                               | Use container with docker-compose in current directory                                                 |
+| ``compose:CONTAINER;path=/path/to/project``                         | Use container with docker-compose in `/path/to/project` directory                               |
+| ``compose:CONTAINER;path=/path/to/project;file=custom-compose-yml`` | Use container with docker-compose in `/path/to/project` directory and `custom-compose.yml` file |
+| ``compose:CONTAINER;project-name=foobar``                           | Use container with docker-compose in current directory with project name `foobar`               |
+| ``compose:CONTAINER;host=example.com``                              | Use container with docker-compose in current directory with docker host `example.com`           |
+| ``compose:CONTAINER;env[FOOBAR]=BARFOO``                            | Use container with docker-compose in current directory with env var `FOOBAR` set to `BARFOO`    |
+
+| Query style configuration                                             | Description                                                                                            |
+|:----------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------|
+| ``compose://CONTAINER``                                               | Use container with docker-compose in current directory                                          |
+| ``compose://CONTAINER?path=/path/to/project``                         | Use container with docker-compose in `/path/to/project` directory                               |
+| ``compose://CONTAINER?path=/path/to/project&file=custom-compose-yml`` | Use container with docker-compose in `/path/to/project` directory and `custom-compose.yml` file |
+| ``compose://CONTAINER?project-name=foobar``                           | Use container with docker-compose in current directory with project name `foobar`               |
+| ``compose://CONTAINER?host=example.com``                              | Use container with docker-compose in current directory with docker host `example.com`           |
+| ``compose://CONTAINER?env[FOOBAR]=BARFOO``                            | Use container with docker-compose in current directory with env var `FOOBAR` set to `BARFOO`    |
diff --git a/main.go b/main.go
@@ -14,7 +14,7 @@ const (
 	// application informations
 	Name    = "gosync"
 	Author  = "webdevops.io"
-	Version = "0.4.0"
+	Version = "0.4.1"
 
 	// self update informations
 	GithubOrganization  = "webdevops"