From 55ec5f5ab9253de5ffb5f0c7c1e48e787a01842e Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Wed, 9 Jan 2019 15:54:47 -0800 Subject: [PATCH] Move custom server troubleshooting code to its own page Most people won't need to do this, so let's move it to the troubleshooting page --- docs/index.rst | 1 + docs/install/custom-server.rst | 18 +++----------- docs/troubleshooting/providers/custom.rst | 30 +++++++++++++++++++++++ 3 files changed, 34 insertions(+), 15 deletions(-) create mode 100644 docs/troubleshooting/providers/custom.rst diff --git a/docs/index.rst b/docs/index.rst index 3bc5597..ea6e6b9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -130,6 +130,7 @@ here to better support your favorite provider! troubleshooting/providers/google troubleshooting/providers/amazon + troubleshooting/providers/custom Contributing ============ diff --git a/docs/install/custom-server.rst b/docs/install/custom-server.rst index 1cfe9f5..651abce 100644 --- a/docs/install/custom-server.rst +++ b/docs/install/custom-server.rst @@ -25,27 +25,15 @@ Pre-requisites #. Ability to ``ssh`` into the server & run commands from the prompt. #. A **IP address** where the server can be reached from the browsers of your target audience. +If you run into issues, look at the specific :ref:`troubleshooting guide ` +for custom server installations. + Step 1: Installing The Littlest JupyterHub ========================================== #. Using a terminal program, SSH into your server. This should give you a prompt where you can type commands. -#. If your server is behind a firewall and needs a proxy to reach the internet: - - .. code-block:: bash - - export http_proxy= - -#. Some requests will fail if your certs are self-signed. Copy the text below and paste it - into the terminal after replacing ```` - with the **path of the directory containing your ssl certificates** (don't include the brackets!).: - - .. code:: - - export REQUESTS_CA_BUNDLE= - sudo npm config set cafile= - #. Make sure you have ``Python3``, ``curl`` and ``git`` installed. On latest Ubuntu you can get all of these with: .. code:: diff --git a/docs/troubleshooting/providers/custom.rst b/docs/troubleshooting/providers/custom.rst new file mode 100644 index 0000000..a8134e0 --- /dev/null +++ b/docs/troubleshooting/providers/custom.rst @@ -0,0 +1,30 @@ +.. _troubleshooting/providers/custom: + +========================================= +Troubleshooting issues on your own server +========================================= + +This is an incomplete list of issues people have run into +when installing TLJH on their own servers, and ways they +have fixed them. + +Outgoing HTTP proxy required +============================ +If your server is behind a firewall that requires a HTTP proxy to reach +the internet, run these commands before running the installer + +.. code-block:: bash + + export http_proxy= + +HTTPS certificate interception +============================== + +If your server is behind a firewall that intercepts HTTPS requests +and re-signs them, you might have to explicitly tell TLJH which +certificates to use. + +.. code:: + + export REQUESTS_CA_BUNDLE= + sudo npm config set cafile= \ No newline at end of file