Skip to content

Commit 027c3cf

Browse files
committed
docs: jwilder/docker-gen -> nginxproxy/docker-gen
1 parent b7e1362 commit 027c3cf

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/Advanced-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Advanced usage (with the nginx and docker-gen containers)
22

3-
**nginx-proxy** can also be run as two separate containers using the [jwilder/**docker-gen**](https://github.com/jwilder/docker-gen) image and the official [**nginx**](https://hub.docker.com/_/nginx/) image. You may want to do this to prevent having the docker socket bound to a publicly exposed container service (ie avoid mounting the docker socket in the nginx exposed container).
3+
**nginx-proxy** can also be run as two separate containers using the [nginx-proxy/**docker-gen**](https://github.com/nginx-proxy/docker-gen) image and the official [**nginx**](https://hub.docker.com/_/nginx/) image. You may want to do this to prevent having the docker socket bound to a publicly exposed container service (ie avoid mounting the docker socket in the nginx exposed container).
44

55
**NOTE**: The first time this container is launched in a three container setup, it will generates a new 2048 bits Diffie-Hellman parameters file. This process can take up to several minutes to complete on lower end hosts, and certificates creation won't start before that (be patient).
66

@@ -44,7 +44,7 @@ $ docker run --detach \
4444
--volumes-from nginx-proxy \
4545
--volume /path/to/nginx.tmpl:/etc/docker-gen/templates/nginx.tmpl:ro \
4646
--volume /var/run/docker.sock:/tmp/docker.sock:ro \
47-
jwilder/docker-gen \
47+
nginxproxy/docker-gen \
4848
-notify-sighup nginx-proxy -watch -wait 5s:30s /etc/docker-gen/templates/nginx.tmpl /etc/nginx/conf.d/default.conf
4949
```
5050

docs/Docker-Compose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ services:
7575
network_mode: bridge
7676
7777
docker-gen:
78-
image: jwilder/docker-gen
78+
image: nginxproxy/docker-gen
7979
container_name: nginx-proxy-gen
8080
command: -notify-sighup nginx-proxy -watch /etc/docker-gen/templates/nginx.tmpl /etc/nginx/conf.d/default.conf
8181
volumes_from:

docs/Getting-containers-IDs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ And two methods to inform the **acme-companion** container of the **docker-gen**
1818

1919
The methods for each container are sorted by order of precedence, meaning that if you use both the label and the volumes_from method, the ID of the **nginx**/**nginx-proxy** container that will be used will be the one found using the label. **There is no point in using more than one method at a time for either the nginx/nginx-proxy or docker-gen container beside potentially confusing yourself**.
2020

21-
The advantage the `label` methods have over the `environment variable` (and `volumes_from`) methods is enabling the use of the **acme-companion** in environments where containers names are dynamic, like in Swarm Mode or in Docker Cloud. Howhever if you intend to do so, as upstream **docker-gen** lacks the ability to identify containers from labels, you'll need both to either use the two containers setup or to replace jwilder/docker-gen with a fork that has this ability like [herlderco/docker-gen](https://github.com/helderco/docker-gen). Be advised that for now, this works to a very limited extent [(everything has to be on the same node)](https://github.com/nginx-proxy/acme-companion/pull/231#issuecomment-330624331).
21+
The advantage the `label` methods have over the `environment variable` (and `volumes_from`) methods is enabling the use of the **acme-companion** in environments where containers names are dynamic, like in Swarm Mode or in Docker Cloud. Howhever if you intend to do so, as upstream **docker-gen** lacks the ability to identify containers from labels, you'll need both to either use the two containers setup or to replace nginx-proxy/docker-gen with a fork that has this ability like [herlderco/docker-gen](https://github.com/helderco/docker-gen). Be advised that for now, this works to a very limited extent [(everything has to be on the same node)](https://github.com/nginx-proxy/acme-companion/pull/231#issuecomment-330624331).
2222

2323
#### Examples with three containers setups:
2424

@@ -32,7 +32,7 @@ $ docker run --detach \
3232
$ docker run --detach \
3333
[...]
3434
--label com.github.jrcs.letsencrypt_nginx_proxy_companion.docker_gen \
35-
jwilder/docker-gen
35+
nginxproxy/docker-gen
3636
3737
$ docker run --detach \
3838
[...]
@@ -49,7 +49,7 @@ $ docker run --detach \
4949
$ docker run --detach \
5050
[...]
5151
--name another-unique-container-name \
52-
jwilder/docker-gen
52+
nginxproxy/docker-gen
5353
5454
$ docker run --detach \
5555
[...]
@@ -68,7 +68,7 @@ $ docker run --detach \
6868
$ docker run --detach \
6969
[...]
7070
--label com.github.jrcs.letsencrypt_nginx_proxy_companion.docker_gen \
71-
jwilder/docker-gen
71+
nginxproxy/docker-gen
7272
7373
$ docker run --detach \
7474
[...]
@@ -86,7 +86,7 @@ $ docker run --detach \
8686
$ docker run --detach \
8787
[...]
8888
--name another-unique-container-name \
89-
jwilder/docker-gen
89+
nginxproxy/docker-gen
9090
9191
$ docker run --detach \
9292
[...]

0 commit comments

Comments
 (0)