diff --git a/README.md b/README.md index 0867cecd..74732017 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ letsencrypt-nginx-proxy-companion is a lightweight companion container for the [ ***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). +![schema](./schema.png) + #### Usage 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 The `LETSENCRYPT_KEYSIZE` variable determines the size of the requested key (in bit, defaults to 4096). +**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. + ##### multi-domain ([SAN](https://www.digicert.com/subject-alternative-name.htm)) certificates 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. diff --git a/schema.png b/schema.png new file mode 100644 index 00000000..7f9718e1 Binary files /dev/null and b/schema.png differ