Skip to content

Commit edb72a5

Browse files
committed
Update release 0.3.1 links and docs
1 parent 22bfc95 commit edb72a5

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ docker-gen can be used to generate various kinds of files for:
1616

1717
#### Host Install
1818

19-
Linux binaries for release [0.2.0](https://github.com/jwilder/docker-gen/releases)
19+
Linux binaries for release [0.3.1](https://github.com/jwilder/docker-gen/releases)
2020

21-
* [amd64](https://github.com/jwilder/docker-gen/releases/download/0.2.0/docker-gen-linux-amd64-0.2.0.tar.gz)
22-
* [i386](https://github.com/jwilder/docker-gen/releases/download/0.2.0/docker-gen-linux-i386-0.2.0.tar.gz)
21+
* [amd64](https://github.com/jwilder/docker-gen/releases/download/0.3.1/docker-gen-linux-amd64-0.3.1.tar.gz)
22+
* [i386](https://github.com/jwilder/docker-gen/releases/download/0.3.1/docker-gen-linux-i386-0.3.1.tar.gz)
2323

2424
Download the version you need, untar, and install to your PATH.
2525

2626
```
27-
$ wget https://github.com/jwilder/docker-gen/releases/download/0.2.0/docker-gen-linux-amd64-0.2.0.tar.gz
28-
$ tar xvzf tar xvzf docker-gen-linux-amd64-0.2.0.tar.gz
27+
$ wget https://github.com/jwilder/docker-gen/releases/download/0.3.1/docker-gen-linux-amd64-0.3.1.tar.gz
28+
$ tar xvzf docker-gen-linux-amd64-0.3.1.tar.gz
2929
$ ./docker-gen
3030
```
3131

@@ -37,17 +37,25 @@ See [jwilder/nginx-proxy](https://index.docker.io/u/jwilder/nginx-proxy/) truste
3737
### Usage
3838
```
3939
$ docker-gen
40-
Usage: docker-gen [-config file] [-watch=false] [-notify="restart xyz"] [-interval=0] [-endpoint tcp|unix://..] <template> [<dest>]
40+
Usage: docker-gen [options] <template> [<dest>]
4141
```
4242

43+
[-config file] [-watch=false] [-notify="restart xyz"] [-interval=0] [-endpoint tcp|unix://..]
44+
4345
*Options:*
44-
* `-watch` - runs continuously and monitors docker container events. When containers are started
45-
or stopped, the template is regenerated.
46-
* `-notify` - runs a command after the template is generated. Useful for restarting nginx, reloading
47-
haproxy, etc..
48-
* `-config file` - Use the specified config file instead of command-line options. Multiple templates can be defined and they will be executed in the order that they appear in the config file.
49-
* `-interval <secs>` - Run the notify command on a fixed interval. Useful for service registration use cases.
50-
* `-endpoint tcp|unix://..` - Use a different docker remote API endpoint. This can also be set w/ a `DOCKER_HOST` environment variable.
46+
```
47+
-config="": Use the specified config file instead of command-line options. Multiple templates can be defined and
48+
they will be executed in the order that they appear in the config file.
49+
-endpoint="": docker api endpoint [tcp|unix://..]. This can also be set w/ a `DOCKER_HOST` environment.
50+
-interval=0:run notify command interval (s). Useful for service registration use cases.
51+
-notify="": run command after template is regenerated ["restart xyz"]. Useful for restarting nginx,
52+
reloading haproxy, etc..
53+
-only-exposed=false: only include containers with exposed ports
54+
-only-published=false: only include containers with published ports (implies -only-exposed)
55+
-version=false: show version
56+
-watch=false: run continuously and monitors docker container events. When containers are started
57+
or stopped, the template is regenerated.
58+
```
5159

5260
If no `<dest>` file is specified, the output is sent to stdout. Mainly useful for debugging.
5361

0 commit comments

Comments
 (0)