Skip to content

Commit 92379d8

Browse files
committed
Update Readme
1 parent 31d2ed1 commit 92379d8

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,12 @@ Finally, start your containers with `VIRTUAL_HOST` environment variables.
150150
$ docker run -e VIRTUAL_HOST=foo.bar.com ...
151151
### SSL Support using letsencrypt
152152

153-
[letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion) is a lightweight companion container for the nginx-proxy. It allow the creation/renewal of Let's Encrypt certificates automatically.
153+
[letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion) is a lightweight companion container for the nginx-proxy. It allow the creation/renewal of Let's Encrypt certificates automatically.
154154

155-
Set `GENERATE_DHPARAM` environment variable to `false` to disabled Diffie-Hellman parameters completely. This will also ignore auto-generation made by `nginx-proxy`.
155+
Set `DHPARAM_GENERATION` environment variable to `false` to disabled Diffie-Hellman parameters completely. This will also ignore auto-generation made by `nginx-proxy`.
156156
The default value is `true`
157157

158-
$ docker run -e GENERATE_DHPARAM=false ....
158+
$ docker run -e DHPARAM_GENERATION=false ....
159159
### SSL Support
160160

161161
SSL is supported using single host, wildcard and SNI certificates using naming conventions for
@@ -187,7 +187,7 @@ at startup. Since it can take minutes to generate a new `dhparam.pem`, it is do
187187
background. Once generation is complete, the `dhparams.pem` is saved on a persistent volume and nginx
188188
is reloaded. This generation process only occurs the first time you start `nginx-proxy`.
189189

190-
> COMPATIBILITY WARNING: The default generated `dhparam.pem` key is 2048 bits for A+ security. Some
190+
> COMPATIBILITY WARNING: The default generated `dhparam.pem` key is 2048 bits for A+ security. Some
191191
> older clients (like Java 6 and 7) do not support DH keys with over 1024 bits. In order to support these
192192
> clients, you must either provide your own `dhparam.pem`, or tell `nginx-proxy` to generate a 1024-bit
193193
> key on startup by passing `-e DHPARAM_BITS=1024`.
@@ -210,7 +210,7 @@ The SSL cipher configuration is based on the [Mozilla nginx intermediate profile
210210
should provide compatibility with clients back to Firefox 1, Chrome 1, IE 7, Opera 5, Safari 1,
211211
Windows XP IE8, Android 2.3, Java 7. Note that the DES-based TLS ciphers were removed for security.
212212
The configuration also enables HSTS, PFS, OCSP stapling and SSL session caches. Currently TLS 1.0, 1.1 and 1.2
213-
are supported. TLS 1.0 is deprecated but its end of life is not until June 30, 2018. It is being
213+
are supported. TLS 1.0 is deprecated but its end of life is not until June 30, 2018. It is being
214214
included because the following browsers will stop working when it is removed: Chrome < 22, Firefox < 27,
215215
IE < 11, Safari < 7, iOS < 5, Android Browser < 5.
216216

@@ -227,12 +227,12 @@ a 500.
227227

228228
To serve traffic in both SSL and non-SSL modes without redirecting to SSL, you can include the
229229
environment variable `HTTPS_METHOD=noredirect` (the default is `HTTPS_METHOD=redirect`). You can also
230-
disable the non-SSL site entirely with `HTTPS_METHOD=nohttp`, or disable the HTTPS site with
231-
`HTTPS_METHOD=nohttps`. `HTTPS_METHOD` must be specified on each container for which you want to
232-
override the default behavior. If `HTTPS_METHOD=noredirect` is used, Strict Transport Security (HSTS)
233-
is disabled to prevent HTTPS users from being redirected by the client. If you cannot get to the HTTP
234-
site after changing this setting, your browser has probably cached the HSTS policy and is automatically
235-
redirecting you back to HTTPS. You will need to clear your browser's HSTS cache or use an incognito
230+
disable the non-SSL site entirely with `HTTPS_METHOD=nohttp`, or disable the HTTPS site with
231+
`HTTPS_METHOD=nohttps`. `HTTPS_METHOD` must be specified on each container for which you want to
232+
override the default behavior. If `HTTPS_METHOD=noredirect` is used, Strict Transport Security (HSTS)
233+
is disabled to prevent HTTPS users from being redirected by the client. If you cannot get to the HTTP
234+
site after changing this setting, your browser has probably cached the HSTS policy and is automatically
235+
redirecting you back to HTTPS. You will need to clear your browser's HSTS cache or use an incognito
236236
window / different browser.
237237

238238
### Basic Authentication Support
@@ -348,7 +348,7 @@ Before submitting pull requests or issues, please check github to make sure an e
348348
To run tests, you need to prepare the docker image to test which must be tagged `jwilder/nginx-proxy:test`:
349349

350350
docker build -t jwilder/nginx-proxy:test . # build the Debian variant image
351-
351+
352352
and call the [test/pytest.sh](test/pytest.sh) script.
353353

354354
Then build the Alpine variant of the image:
@@ -361,6 +361,6 @@ and call the [test/pytest.sh](test/pytest.sh) script again.
361361
If your system has the `make` command, you can automate those tasks by calling:
362362

363363
make test
364-
365364

366-
You can learn more about how the test suite works and how to write new tests in the [test/README.md](test/README.md) file.
365+
366+
You can learn more about how the test suite works and how to write new tests in the [test/README.md](test/README.md) file.

0 commit comments

Comments
 (0)