From 5c9e9d65b534d9dd03f4bfa0a408f18267a6aa7c Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Wed, 18 May 2016 10:52:49 -0700 Subject: [PATCH] Add links to SSL section in docs --- docs/source/getting-started.md | 5 ++++- docs/source/troubleshooting.md | 8 ++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index 80014fc1..dd53f305 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -190,7 +190,10 @@ Some cert files also contain the key, in which case only the cert is needed. It these files be put in a secure location on your server, where they are not readable by regular users. -Note: In certain cases, e.g. behind SSL termination in nginx, allowing no SSL +Note on **chain certificates**: If you are using a chain certificate, see also +[chained certificate for SSL](#chained-certificates-for-ssl) in the JupyterHub troubleshooting FAQ). + +Note: In certain cases, e.g. **behind SSL termination in nginx**, allowing no SSL running on the hub may be desired. To run the Hub without SSL, you must opt in by configuring and confirming the `--no-ssl` option, added as of [version 0.5](./changelog.html). diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index fadc6d38..26e07b26 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -134,11 +134,11 @@ when starting JupyterHub or more conveniently set the `ssl_cert` variable in JupyterHub's configuration file, `jupyterhub_config.py`. In `jupyterhub_config.py`, set: - c.JupyterHub.ssl_cert = example_host-chained.crt - c.JupyterHub.ssl_key = example_host.key + c.JupyterHub.ssl_cert = /path/to/example_host-chained.crt + c.JupyterHub.ssl_key = /path/to/example_host.key -and set ssl_cert to your_name-chained.crt and ssl_key to your private key. +where `ssl_cert` is example-chained.crt and ssl_key to your private key. Then restart JupyterHub. - +See also [JupyterHub SSL encryption](getting-started.md#ssl-encryption).