Skip to content

Commit f289fba

Browse files
authored
Merge pull request #276 from revolunet/master
add some documentation
2 parents f4b4e00 + 2172866 commit f289fba

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ letsencrypt-nginx-proxy-companion is a lightweight companion container for the [
1313

1414
***NOTE***: The first time this container is launched it generates a new Diffie-Hellman group file. This process can take several minutes to complete (be patient).
1515

16+
![schema](./schema.png)
17+
1618
#### Usage
1719

1820
To use it with original [nginx-proxy](https://github.com/jwilder/nginx-proxy) container you must declare 3 writable volumes from the [nginx-proxy](https://github.com/jwilder/nginx-proxy) container:
@@ -123,6 +125,8 @@ The following environment variables are optional and parameterize the way the Le
123125

124126
The `LETSENCRYPT_KEYSIZE` variable determines the size of the requested key (in bit, defaults to 4096).
125127

128+
**Note:** the `VIRTUAL_HOST` (or `LETSENCRYPT_HOST`) must be a reachable domain for LetEncrypt to be able to validate the challenge and provide the certificate.
129+
126130
##### multi-domain ([SAN](https://www.digicert.com/subject-alternative-name.htm)) certificates
127131
If you want to create multi-domain ([SAN](https://www.digicert.com/subject-alternative-name.htm)) certificates add the base domain as the first domain of the `LETSENCRYPT_HOST` environment variable.
128132

schema.png

39.6 KB
Loading

0 commit comments

Comments
 (0)