From 19b646888934d56e1fe881e43b193fe628f02981 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 14 Mar 2016 16:48:49 -0700 Subject: [PATCH 1/3] Add no-SSL option to docs --- docs/source/getting-started.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index 746c57d9..89007f8c 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -22,9 +22,12 @@ There are three main categories of processes run by the `jupyterhub` command lin ## JupyterHub's default behavior -**IMPORTANT:** In its default configuration, JupyterHub runs without SSL encryption (HTTPS). +**IMPORTANT:** In its default configuration, JupyterHub requires SSL encryption (HTTPS) to run. **You should not run JupyterHub without SSL encryption on a public network.** -See [Security documentation](#Security) for how to configure JupyterHub to use SSL. +See [Security documentation](#Security) for how to configure JupyterHub to use SSL and, in +certain cases, e.g. behind SSL termination in nginx, allowing no SSL on the hub +by requiring `--no-ssl` confirmation to allow the Hub to be run without SSL +as of [version 5.0](./changelog.html). To start JupyterHub in its default configuration, type the following at the command line: @@ -147,7 +150,7 @@ c.JupyterHub.hub_port = 54321 ## Security -**IMPORTANT:** In its default configuration, JupyterHub runs without SSL encryption (HTTPS). +**IMPORTANT:** In its default configuration, JupyterHub requires SSL encryption (HTTPS) to run. **You should not run JupyterHub without SSL encryption on a public network.** Security is the most important aspect of configuring Jupyter. There are three main aspects of the @@ -181,6 +184,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 +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 5.0](./changelog.html). + ## Cookie secret The cookie secret is an encryption key, used to encrypt the browser cookies used for From 11df935f34bf7c2382b9d02ab365d307dd9d6d88 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 14 Mar 2016 16:54:04 -0700 Subject: [PATCH 2/3] Fix awkward wording --- docs/source/getting-started.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index 89007f8c..842db653 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -24,10 +24,9 @@ There are three main categories of processes run by the `jupyterhub` command lin **IMPORTANT:** In its default configuration, JupyterHub requires SSL encryption (HTTPS) to run. **You should not run JupyterHub without SSL encryption on a public network.** -See [Security documentation](#Security) for how to configure JupyterHub to use SSL and, in -certain cases, e.g. behind SSL termination in nginx, allowing no SSL on the hub -by requiring `--no-ssl` confirmation to allow the Hub to be run without SSL -as of [version 5.0](./changelog.html). +See [Security documentation](#Security) for how to configure JupyterHub to use SSL, and in +certain cases, e.g. behind SSL termination in nginx, allowing the hub to run with no SSL +by requiring `--no-ssl` (as of [version 5.0](./changelog.html)). To start JupyterHub in its default configuration, type the following at the command line: From b71f34eb3c96756739f60507b25d6852640e9093 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 14 Mar 2016 16:57:12 -0700 Subject: [PATCH 3/3] Fix transposed version number --- docs/source/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index 842db653..2d27b92c 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -26,7 +26,7 @@ There are three main categories of processes run by the `jupyterhub` command lin **You should not run JupyterHub without SSL encryption on a public network.** See [Security documentation](#Security) for how to configure JupyterHub to use SSL, and in certain cases, e.g. behind SSL termination in nginx, allowing the hub to run with no SSL -by requiring `--no-ssl` (as of [version 5.0](./changelog.html)). +by requiring `--no-ssl` (as of [version 0.5](./changelog.html)). To start JupyterHub in its default configuration, type the following at the command line: @@ -185,7 +185,7 @@ users. 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 5.0](./changelog.html). +in by configuring and confirming the `--no-ssl` option, added as of [version 0.5](./changelog.html). ## Cookie secret