mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Add instructions for installation on your own server
This commit is contained in:
@@ -17,6 +17,7 @@ started!
|
||||
tutorials/digitalocean
|
||||
tutorials/jetstream
|
||||
tutorials/google
|
||||
tutorials/custom
|
||||
|
||||
Guides
|
||||
======
|
||||
|
||||
63
docs/tutorials/custom.rst
Normal file
63
docs/tutorials/custom.rst
Normal file
@@ -0,0 +1,63 @@
|
||||
.. _tutorial_quickstart_custom:
|
||||
|
||||
=======================================
|
||||
Tutorial: JupyterHub on your own server
|
||||
=======================================
|
||||
|
||||
Goal
|
||||
====
|
||||
|
||||
By the end of this tutorial, you should have a JupyterHub with some admin
|
||||
users and a user environment with packages you want installed running on
|
||||
a server you have access to.
|
||||
|
||||
Pre-requisites
|
||||
==============
|
||||
|
||||
#. Some familiarity with the command line.
|
||||
#. A server running Ubuntu 18.04 where you have root access.
|
||||
#. Ability to ``ssh`` into the server & run commands from the prompt.
|
||||
#. A **public IP** where the server can be accessed from the internet.
|
||||
|
||||
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.
|
||||
|
||||
#. Copy the text below, and paste it into the terminal. Replace
|
||||
``<admin-user-name>`` with the name of the first **admin user** for this
|
||||
JupyterHub. This admin user can log in after the JupyterHub is set up, and
|
||||
can configure it to their needs. Remember the username!
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
#!/bin/bash
|
||||
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \
|
||||
| sudo python3 - \
|
||||
--admin <admin-user-name>
|
||||
|
||||
#. Press ``Enter`` to start the installation process. This will take 5-10 minutes,
|
||||
and will say 'Done!' when the installation process is complete.
|
||||
|
||||
#. Copy the **Public IP** of your server, and try accessing http://<public-ip> from
|
||||
your browser. If everything went well, this should give you a JupyterHub login page.
|
||||
|
||||
.. image:: ../images/first-login.png
|
||||
:alt: JupyterHub log-in page
|
||||
|
||||
#. Login using the **admin user name** you used in step 2, and a password. Use a
|
||||
strong password & note it down somewhere, since this will be the password for
|
||||
the admin user account from now on.
|
||||
|
||||
#. Congratulations, you have a running working JupyterHub!
|
||||
|
||||
Step 2: Adding more users
|
||||
==========================
|
||||
|
||||
.. include:: add_users.txt
|
||||
|
||||
Step 3: Install conda / pip packages for all users
|
||||
==================================================
|
||||
|
||||
.. include:: add_packages.txt
|
||||
Reference in New Issue
Block a user