zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #253 from yuvipanda/cleanup-server

Browse Source 
Move custom server troubleshooting code to its own page
This commit is contained in:
Yuvi Panda
2019-01-11 10:20:28 -08:00
committed by GitHub
parent 4a1c1b821c 55ec5f5ab9
commit 058377229d
3 changed files with 34 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.rst
View File

@@ -130,6 +130,7 @@ here to better support your favorite provider!
troubleshooting/providers/google
troubleshooting/providers/amazon
troubleshooting/providers/custom
Contributing
============

18
docs/install/custom-server.rst
View File

@@ -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 <troubleshooting/providers/custom>`
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=<your_proxy>
#. Some requests will fail if your certs are self-signed. Copy the text below and paste it
into the terminal after replacing ``</directory/with/your/ssl/certificates>``
with the **path of the directory containing your ssl certificates** (don't include the brackets!).:
.. code::
export REQUESTS_CA_BUNDLE=</directory/with/your/ssl/certificates>
sudo npm config set cafile=</directory/with/your/ssl/certificates>
#. Make sure you have ``Python3``, ``curl`` and ``git`` installed. On latest Ubuntu you can get all of these with:
.. code::

30
docs/troubleshooting/providers/custom.rst Normal file
View File

@@ -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=<your_proxy-server>
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=</directory/with/your/ssl/certificates>
sudo npm config set cafile=</directory/with/your/ssl/certificates>