Skip to content

Commit ba8ae0f

Browse files
committed
[skip-ci] recommend using DEFAULT_EMAIL
instead or in addition to LETSENCRYPT_EMAIL
1 parent a0b59c9 commit ba8ae0f

File tree

4 files changed

+8
-10
lines changed

4 files changed

+8
-10
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,14 @@ $ docker run --detach \
6565
--name nginx-proxy-letsencrypt \
6666
--volumes-from nginx-proxy \
6767
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
68+
6869
jrcs/letsencrypt-nginx-proxy-companion
6970
```
7071

7172
The host docker socket has to be bound inside this container too, this time to `/var/run/docker.sock`.
7273

74+
Albeit **optional**, it is **recommended** to provide a valid default email address through the `DEFAULT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
75+
7376
### Step 3 - proxyed container(s)
7477

7578
Once both **nginx-proxy** and **letsencrypt-nginx-proxy-companion** containers are up and running, start any container you want proxyed with environment variables `VIRTUAL_HOST` and `LETSENCRYPT_HOST` both set to the domain(s) your proxyed container is going to use.
@@ -83,12 +86,9 @@ $ docker run --detach \
8386
--name your-proxyed-app \
8487
--env "VIRTUAL_HOST=subdomain.yourdomain.tld" \
8588
--env "LETSENCRYPT_HOST=subdomain.yourdomain.tld" \
86-
8789
nginx
8890
```
8991

90-
Albeit **optional**, it is **recommended** to provide a valid email address through the `LETSENCRYPT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
91-
9292
The containers being proxied must expose the port to be proxied, either by using the `EXPOSE` directive in their Dockerfile or by using the `--expose` flag to `docker run` or `docker create`.
9393

9494
If the proxyed container listen on and expose another port than the default `80`, you can force **nginx-proxy** to use this port with the [`VIRTUAL_PORT`](https://github.com/jwilder/nginx-proxy#multiple-ports) environment variable.

docs/Advanced-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ $ docker run --detach \
6262
--volumes-from nginx-proxy \
6363
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
6464
--env "NGINX_DOCKER_GEN_CONTAINER=nginx-proxy-gen" \
65+
6566
jrcs/letsencrypt-nginx-proxy-companion
6667
```
6768

@@ -74,7 +75,6 @@ $ docker run --detach \
7475
--name your-proxyed-app
7576
--env "VIRTUAL_HOST=subdomain.yourdomain.tld" \
7677
--env "LETSENCRYPT_HOST=subdomain.yourdomain.tld" \
77-
7878
nginx
7979
```
8080

docs/Basic-usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,14 @@ $ docker run --detach \
3535
--name nginx-proxy-letsencrypt \
3636
--volumes-from nginx-proxy \
3737
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
38+
3839
jrcs/letsencrypt-nginx-proxy-companion
3940
```
4041

4142
The host docker socket has to be bound inside this container too, this time to `/var/run/docker.sock`.
4243

44+
Albeit **optional**, it is **recommended** to provide a valid default email address through the `DEFAULT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
45+
4346
### Step 3 - proxyed container(s)
4447

4548
Once both **nginx-proxy** and **letsencrypt-nginx-proxy-companion** containers are up and running, start any container you want proxyed with environment variables `VIRTUAL_HOST` and `LETSENCRYPT_HOST` both set to the domain(s) your proxyed container is going to use. Multiple hosts can be separated using commas.
@@ -53,12 +56,9 @@ $ docker run --detach \
5356
--name your-proxyed-app
5457
--env "VIRTUAL_HOST=subdomain.yourdomain.tld" \
5558
--env "LETSENCRYPT_HOST=subdomain.yourdomain.tld" \
56-
5759
nginx
5860
```
5961

60-
Albeit **optional**, it is **recommended** to provide a valid email address through the `LETSENCRYPT_EMAIL` environment variable, so that Let's Encrypt can warn you about expiring certificates and allow you to recover your account.
61-
6262
The containers being proxied must expose the port to be proxied, either by using the `EXPOSE` directive in their Dockerfile or by using the `--expose` flag to `docker run` or `docker create`.
6363

6464
If the proxyed container listen on and expose another port than the default `80`, you can force **nginx-proxy** to use this port with the [`VIRTUAL_PORT`](https://github.com/jwilder/nginx-proxy#multiple-ports) environment variable.

docs/Let's-Encrypt-and-ACME.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ The `LETSENCRYPT_MIN_VALIDITY` environment variable can be used to set a differe
1919

2020
#### Contact address
2121

22-
The `LETSENCRYPT_EMAIL` environment variable must be a valid email and will be used by Let's Encrypt to warn you of impeding certificate expiration (should the automated renewal fail) and to recover an account. It is **recommended** to provide a valid contact address using this variable.
23-
24-
If you want to do this globally for all containers, set `DEFAULT_EMAIL` on the **letsencrypt_nginx_proxy_companion container**.
22+
The `LETSENCRYPT_EMAIL` environment variable must be a valid email and will be used by Let's Encrypt to warn you of impeding certificate expiration (should the automated renewal fail) and to recover an account. For reasons detailed below, it is **recommended** to provide a default valid contact address for all containers by setting the [`DEFAULT_EMAIL`](#default-contact-address) environment variable on the **letsencrypt_nginx_proxy_companion container**.
2523

2624
**Please note that for each separate [ACME account](#acme-account-keys), only the email provided as a container environment variable at the time of this account creation will be subsequently used. If you don't provide an email address when the account is created, this account will remain without a contact address even if you provide an address in the future.**
2725

0 commit comments

Comments
 (0)