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

Normalize heading levels to match documentation guidelines

Browse Source
This commit is contained in:
yuvipanda
2018-07-10 11:35:18 -07:00
parent 13dcd2f871
commit 35517aab5c
11 changed files with 47 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/contributing/dev-setup.rst
View File

@@ -1,5 +1,6 @@
.. _contributing_dev_setup: .. _contributing_dev_setup:
==================================
Setting up Development Environment Setting up Development Environment
================================== ==================================

3
docs/guides/admin.rst
View File

@@ -1,7 +1,8 @@
.. _admin_access: .. _admin_access:
=====================
Administrative Access Administrative Access
--------------------- =====================
In The Littlest JupyterHub, we try to allow users to do as many administrative In The Littlest JupyterHub, we try to allow users to do as many administrative
tasks as possible within JupyterHub itself. Admin users can: tasks as possible within JupyterHub itself. Admin users can:

5
docs/guides/install.rst
View File

@@ -1,10 +1,11 @@
.. _installation: .. _installation:
============
Installation Installation
============ ============
Quick Installation Quick Installation
------------------ ==================
The quick way to install The Littlest JupyterHub (tljh) is: The quick way to install The Littlest JupyterHub (tljh) is:
@@ -19,7 +20,7 @@ You should probably add yourself as an `admin user <admin.rst>`_
after installation. after installation.
Slightly less quick installation Slightly less quick installation
-------------------------------- ================================
If you can read ``python3`` and are nervous about the previous installation method, If you can read ``python3`` and are nervous about the previous installation method,
you can inspect the installer script before running it. you can inspect the installer script before running it.

5
docs/guides/notebook-interfaces.rst
View File

@@ -1,5 +1,6 @@
.. _notebook_interfaces: .. _notebook_interfaces:
==================================================
Notebook Interfaces (Classic, JupyterLab, nteract) Notebook Interfaces (Classic, JupyterLab, nteract)
================================================== ==================================================
@@ -14,7 +15,7 @@ Both these interfaces are also shipped with tljh by default. You can try them
temporarily, or set them to be the default interface whenever you login. temporarily, or set them to be the default interface whenever you login.
Trying alternate interface tempoarily Trying alternate interface tempoarily
------------------------------------- =====================================
When you log in & start your server, by default the URL in your browser When you log in & start your server, by default the URL in your browser
will be something like ``/user/<username>/tree``. The ``/tree`` is what tells will be something like ``/user/<username>/tree``. The ``/tree`` is what tells
@@ -26,7 +27,7 @@ the notebook server to give you the classic notebook interface.
You can play around with them and see what fits your use cases best. You can play around with them and see what fits your use cases best.
Changing the default user interface Changing the default user interface
----------------------------------- ===================================
You can change the default interface users get when they log in by modifying You can change the default interface users get when they log in by modifying
``config.yaml`` as an admin user. ``config.yaml`` as an admin user.

9
docs/guides/requirements.rst
View File

@@ -1,23 +1,24 @@
.. _requirements: .. _requirements:
===================
Server Requirements Server Requirements
=================== ===================
Operating System Operating System
---------------- ================
We recommend using Ubuntu 18.04 as the base operating system for your server. We recommend using Ubuntu 18.04 as the base operating system for your server.
Ubuntu 16.04 should also work, but is not officially supported. other Linux Ubuntu 16.04 should also work, but is not officially supported. other Linux
distributions and operating systems are also not officially supported. distributions and operating systems are also not officially supported.
Root access Root access
----------- ===========
Full ``root`` access to this server is required. This might be via ``sudo`` Full ``root`` access to this server is required. This might be via ``sudo``
(recommended) or by direct access to ``root`` (not recommended!) (recommended) or by direct access to ``root`` (not recommended!)
External IP External IP
----------- ===========
An external IP allows users on the internet to reach your JupyterHub. Most An external IP allows users on the internet to reach your JupyterHub. Most
VPS / Cloud providers give you a public IP address along with your server. If VPS / Cloud providers give you a public IP address along with your server. If
@@ -25,7 +26,7 @@ you are hosting on a physical machine somewhere, talk to your system administrat
about how to get HTTP traffic from the world into your server. about how to get HTTP traffic from the world into your server.
Memory (RAM) Memory (RAM)
------------ ============
RAM is often the biggest limiting factor to the question 'how many users can use this JupyterHub RAM is often the biggest limiting factor to the question 'how many users can use this JupyterHub
at the same time?'. If you want to support ``N`` maximum concurrent active users at the same time?'. If you want to support ``N`` maximum concurrent active users

11
docs/guides/user-environment.rst
View File

@@ -1,5 +1,6 @@
.. _user_environment: .. _user_environment:
============================
Customizing user environment Customizing user environment
============================ ============================
@@ -11,7 +12,7 @@ easily.
.. _user_environment_pip: .. _user_environment_pip:
Installing pip packages Installing pip packages
----------------------- =======================
`pip <https://pypi.org/project/pip/>`_ is the recomended tool for installing packages `pip <https://pypi.org/project/pip/>`_ is the recomended tool for installing packages
in Python from the `Python Packaging Index (PyPI) <https://pypi.org/>`_. PyPI has in Python from the `Python Packaging Index (PyPI) <https://pypi.org/>`_. PyPI has
@@ -41,7 +42,7 @@ almost 145,000 packages in it right now, so a lot of what you need is going to b
.. _user_environment_conda: .. _user_environment_conda:
Installing conda packages Installing conda packages
------------------------- =========================
Conda lets you install new languages (such as new versions of python, node, R, etc) Conda lets you install new languages (such as new versions of python, node, R, etc)
as well as packages in those languages. For lots of scientific software, installing as well as packages in those languages. For lots of scientific software, installing
@@ -75,7 +76,7 @@ a community maintained repository of conda packages.
.. _user_environment_apt: .. _user_environment_apt:
Installing apt packages Installing apt packages
----------------------- =======================
`apt <https://help.ubuntu.com/lts/serverguide/apt.html.en>`_ is the official package `apt <https://help.ubuntu.com/lts/serverguide/apt.html.en>`_ is the official package
manager for the `Ubuntu Linux distribution <https://www.ubuntu.com/>`_. You can install manager for the `Ubuntu Linux distribution <https://www.ubuntu.com/>`_. You can install
@@ -112,7 +113,7 @@ make sure to look in the version of Ubuntu you are using!
User environment location User environment location
------------------------- =========================
The user environment is a conda enviornment set up in ``/opt/tljh/user``, with The user environment is a conda enviornment set up in ``/opt/tljh/user``, with
a Python3 kernel as the default. It is readable by all users, but writeable only a Python3 kernel as the default. It is readable by all users, but writeable only
@@ -120,7 +121,7 @@ by users who have root access. This makes it possible for JupyterHub admins (who
root access with ``sudo``) to install software in the user environment easily. root access with ``sudo``) to install software in the user environment easily.
Accessing user environment outside JupyterHub Accessing user environment outside JupyterHub
--------------------------------------------- =============================================
We add ``/opt/tljh/user/bin`` to the ``$PATH`` environment variable for all JupyterHub We add ``/opt/tljh/user/bin`` to the ``$PATH`` environment variable for all JupyterHub
users, so everything installed in the user environment is available to them automatically. users, so everything installed in the user environment is available to them automatically.

3
docs/index.rst
View File

@@ -1,5 +1,6 @@
=======================
The Littlest JupyterHub The Littlest JupyterHub
----------------------- =======================
A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
a small (0-50) number of users on a single server. a small (0-50) number of users on a single server.

9
docs/troubleshooting/logs.rst
View File

@@ -1,5 +1,6 @@
.. _troubleshoot_logs: .. _troubleshoot_logs:
===============
Looking at Logs Looking at Logs
=============== ===============
@@ -19,7 +20,7 @@ user's notebook server. All the logs are accessible via `journalctl <https://www
.. _troubleshoot_logs_jupyterhub: .. _troubleshoot_logs_jupyterhub:
JupyterHub Logs JupyterHub Logs
--------------- ===============
JupyterHub is responsible for user authentication, & starting / stopping user JupyterHub is responsible for user authentication, & starting / stopping user
notebook servers. When there is a general systemic issue with JupyterHub (rather notebook servers. When there is a general systemic issue with JupyterHub (rather
@@ -34,7 +35,7 @@ This command displays logs from JupyterHub itself. See :ref:`journalctl_tips`
for tips on navigating the logs. for tips on navigating the logs.
Configurable HTTP Proxy Logs Configurable HTTP Proxy Logs
---------------------------- ============================
Configurable HTTP Proxy redirects traffic to JupyterHub / user notebook servers Configurable HTTP Proxy redirects traffic to JupyterHub / user notebook servers
as necessary & handles HTTPS. It usually is the least problematic of the components, as necessary & handles HTTPS. It usually is the least problematic of the components,
@@ -48,7 +49,7 @@ This command displays logs from Configurable HTTP Proxy. See :ref:`journalctl_ti
for tips on navigating the logs. for tips on navigating the logs.
User Server Logs User Server Logs
---------------- ================
Each user gets their own notebook server, and this server also produces logs. Each user gets their own notebook server, and this server also produces logs.
Looking at these can be useful when a user can launch their server but run into Looking at these can be useful when a user can launch their server but run into
@@ -65,7 +66,7 @@ See :ref:`journalctl_tips` for tips on navigating the logs.
.. _journalctl_tips: .. _journalctl_tips:
journalctl tips journalctl tips
--------------- ===============
``journalctl`` has a lot of options to make your life as an administrator ``journalctl`` has a lot of options to make your life as an administrator
easier. Here are some very basic tips on effective ``journalctl`` usage. easier. Here are some very basic tips on effective ``journalctl`` usage.

13
docs/tutorials/digitalocean.rst
View File

@@ -1,23 +1,24 @@
.. _tutorial_quickstart_digitalocean: .. _tutorial_quickstart_digitalocean:
=====================================
Tutorial: JupyterHub on Digital Ocean Tutorial: JupyterHub on Digital Ocean
======================================== =====================================
Goal Goal
---- ====
By the end of this tutorial, you should have a JupyterHub with some admin 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 users and a user environment with packages you want installed running on
`DigitalOcean <https://digitalocean.com>`_. `DigitalOcean <https://digitalocean.com>`_.
Pre-requisites Pre-requisites
-------------- ==============
#. A DigitalOcean account with a payment method attached. #. A DigitalOcean account with a payment method attached.
#. Some familiarity with the command line. #. Some familiarity with the command line.
Step 1: Installing The Littlest JupyterHub Step 1: Installing The Littlest JupyterHub
------------------------------------------ ==========================================
Let's create the server on which we can run JupyterHub. Let's create the server on which we can run JupyterHub.
@@ -101,11 +102,11 @@ Let's create the server on which we can run JupyterHub.
#. Congratulations, you have a running working JupyterHub! #. Congratulations, you have a running working JupyterHub!
Step 2: Adding more users Step 2: Adding more users
-------------------------- ==========================
.. include:: add_users.txt .. include:: add_users.txt
Step 3: Install conda / pip packages for all users Step 3: Install conda / pip packages for all users
-------------------------------------------------- ==================================================
.. include:: add_packages.txt .. include:: add_packages.txt

13
docs/tutorials/google.rst
View File

@@ -1,22 +1,23 @@
.. _tutorial_quickstart_google: .. _tutorial_quickstart_google:
====================================
Tutorial: JupyterHub on Google Cloud Tutorial: JupyterHub on Google Cloud
==================================== ====================================
Goal Goal
---- ====
By the end of this tutorial, you should have a JupyterHub with some admin 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 users and a user environment with packages you want installed running on
`Google Cloud <https://cloud.google.com/>`_. `Google Cloud <https://cloud.google.com/>`_.
Prerequisites Prerequisites
------------- =============
#. A Google Cloud account. You might use the free credits for trying it out! #. A Google Cloud account. You might use the free credits for trying it out!
Step 1: Installing The Littlest JupyterHub Step 1: Installing The Littlest JupyterHub
------------------------------------------ ==========================================
Let's create the server on which we can run JupyterHub. Let's create the server on which we can run JupyterHub.
@@ -84,7 +85,7 @@ Let's create the server on which we can run JupyterHub.
For more guidance on the different options available to you, as well as For more guidance on the different options available to you, as well as
pricing considerations on Google Cloud, see the `GCP Choosing a VM Guide <https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type?hl=en_US>`_. pricing considerations on Google Cloud, see the `GCP Choosing a VM Guide <https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type?hl=en_US>`_.
#. Under **Boot Disk**, click the **Change** button. This lets us change the #. Under **Boot Disk**, click the **Change** button. This lets us change the
operating system and the size of your disk. operating system and the size of your disk.
@@ -186,11 +187,11 @@ Let's create the server on which we can run JupyterHub.
#. Congratulations, you have a running working JupyterHub! #. Congratulations, you have a running working JupyterHub!
Step 2: Adding more users Step 2: Adding more users
-------------------------- ==========================
.. include:: add_users.txt .. include:: add_users.txt
Step 3: Install conda / pip packages for all users Step 3: Install conda / pip packages for all users
-------------------------------------------------- ==================================================
.. include:: add_packages.txt .. include:: add_packages.txt

11
docs/tutorials/jetstream.rst
View File

@@ -1,24 +1,25 @@
.. _tutorial_quickstart_jetstream: .. _tutorial_quickstart_jetstream:
=================================
Tutorial: JupyterHub on Jetstream Tutorial: JupyterHub on Jetstream
================================= =================================
Goal Goal
---- ====
By the end of this tutorial, you should have a JupyterHub with some admin 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 users and a user environment with packages you want installed running on
`Jetstream <https://jetstream-cloud.org/>`_. `Jetstream <https://jetstream-cloud.org/>`_.
Prerequisites Prerequisites
------------- =============
#. A Jetstream account with an XSEDE allocation; for more information, #. A Jetstream account with an XSEDE allocation; for more information,
go to the `Jetstream Allocations help page <http://wiki.jetstream-cloud.org/Jetstream+Allocations>`_. go to the `Jetstream Allocations help page <http://wiki.jetstream-cloud.org/Jetstream+Allocations>`_.
#. Some familiarity with the command line. #. Some familiarity with the command line.
Step 1: Installing The Littlest JupyterHub Step 1: Installing The Littlest JupyterHub
------------------------------------------ ==========================================
Let's create the server on which we can run JupyterHub. Let's create the server on which we can run JupyterHub.
@@ -125,11 +126,11 @@ Let's create the server on which we can run JupyterHub.
#. Congratulations, you have a running working JupyterHub! #. Congratulations, you have a running working JupyterHub!
Step 2: Adding more users Step 2: Adding more users
-------------------------- ==========================
.. include:: add_users.txt .. include:: add_users.txt
Step 3: Install conda / pip packages for all users Step 3: Install conda / pip packages for all users
-------------------------------------------------- ==================================================
.. include:: add_packages.txt .. include:: add_packages.txt