2018-07-10 11:35:18 -07:00
|
|
|
=======================
|
2018-06-28 00:39:55 -07:00
|
|
|
The Littlest JupyterHub
|
2018-07-10 11:35:18 -07:00
|
|
|
=======================
|
2018-06-28 00:39:55 -07:00
|
|
|
|
|
|
|
|
A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
|
2018-08-08 10:18:20 -07:00
|
|
|
a small (0-100) number of users on a single server. We recommend reading
|
|
|
|
|
:ref:`topic/whentouse` to determine if this is the right tool for you.
|
2018-06-28 00:39:55 -07:00
|
|
|
|
2018-07-12 14:15:01 -07:00
|
|
|
Development Status
|
|
|
|
|
==================
|
|
|
|
|
|
2018-07-27 17:52:23 -07:00
|
|
|
This project is currently in **alpha** state. Most things work, but we might
|
2018-07-31 09:38:25 -07:00
|
|
|
still make breaking changes that have no clear upgrade pathway. We are targeting
|
2018-07-27 17:52:23 -07:00
|
|
|
a v0.1 release sometime in mid-August 2018. Follow `this milestone <https://github.com/jupyterhub/the-littlest-jupyterhub/milestone/1>`_
|
|
|
|
|
to see progress towards the release!
|
2018-07-12 14:15:01 -07:00
|
|
|
|
2018-07-11 12:00:58 -07:00
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
The Littlest JupyterHub (TLJH) can run on any server that is running at least
|
|
|
|
|
Ubuntu 18.04. We have a bunch of tutorials to get you started.
|
|
|
|
|
|
|
|
|
|
- Tutorials to create a new server from scratch on a cloud provider & run TLJH
|
|
|
|
|
on it. These are **recommended** if you do not have much experience setting up
|
|
|
|
|
servers.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
2018-08-02 12:35:36 -07:00
|
|
|
install/digitalocean
|
|
|
|
|
install/jetstream
|
|
|
|
|
install/google
|
2018-08-11 08:25:21 +02:00
|
|
|
install/custom-server
|
2018-07-11 12:00:58 -07:00
|
|
|
|
2018-07-30 16:08:47 +02:00
|
|
|
Once you are ready to run your server for real,
|
|
|
|
|
it's a good idea to proceed directly to :doc:`howto/https`.
|
|
|
|
|
|
2018-07-26 23:47:07 -07:00
|
|
|
Tutorials
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
Tutorials guide you step-by-step through accomplishing a specific task.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
|
|
|
|
tutorials/nbgitpuller.rst
|
|
|
|
|
|
2018-07-10 14:39:26 -07:00
|
|
|
How-To Guides
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
How-To guides answer the question 'How do I...?' for a lot of topics.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
2018-07-30 16:08:47 +02:00
|
|
|
howto/https
|
2018-07-10 14:39:26 -07:00
|
|
|
howto/user-environment
|
2018-07-28 13:07:01 -07:00
|
|
|
howto/admin-users
|
2018-08-02 16:16:19 -07:00
|
|
|
howto/share-data
|
2018-07-11 01:58:30 -07:00
|
|
|
howto/notebook-interfaces
|
2018-07-21 20:33:14 -07:00
|
|
|
howto/resource-estimation
|
2018-08-05 09:44:28 -07:00
|
|
|
howto/nbresuse
|
2018-07-10 14:39:26 -07:00
|
|
|
|
2018-07-31 09:38:25 -07:00
|
|
|
Authentication
|
2018-08-02 12:30:51 -07:00
|
|
|
--------------
|
2018-07-31 09:38:25 -07:00
|
|
|
|
2018-07-27 22:22:45 -07:00
|
|
|
We have a special set of How-To Guides on using various forms of authentication
|
2018-07-31 09:38:25 -07:00
|
|
|
with your JupyterHub. For more information on Authentication, see
|
|
|
|
|
:ref:`topic/authenticator-configuration`
|
2018-07-27 22:22:45 -07:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
|
|
|
|
howto/auth/dummy
|
2018-08-07 16:20:25 -07:00
|
|
|
howto/auth/github
|
2018-07-27 22:22:45 -07:00
|
|
|
|
2018-07-12 14:15:01 -07:00
|
|
|
Topic Guides
|
|
|
|
|
============
|
2018-06-28 02:34:51 -07:00
|
|
|
|
2018-07-12 14:15:01 -07:00
|
|
|
Topic guides provide in-depth explanations of specific topics.
|
2018-06-28 02:34:51 -07:00
|
|
|
|
2018-06-28 00:39:55 -07:00
|
|
|
.. toctree::
|
2018-06-28 02:34:51 -07:00
|
|
|
:titlesonly:
|
2018-06-28 00:39:55 -07:00
|
|
|
|
2018-08-10 10:23:55 -07:00
|
|
|
topic/whentouse
|
2018-07-21 22:39:15 -07:00
|
|
|
topic/requirements
|
2018-07-12 14:15:01 -07:00
|
|
|
topic/security
|
2018-07-18 01:00:48 -07:00
|
|
|
topic/customizing-installer
|
2018-08-01 18:05:34 -07:00
|
|
|
topic/installer-actions
|
2018-07-27 22:57:59 -07:00
|
|
|
topic/tljh-config
|
2018-07-28 14:32:02 -07:00
|
|
|
topic/authenticator-configuration
|
2018-08-01 02:52:40 -07:00
|
|
|
topic/escape-hatch
|
2018-07-12 14:15:01 -07:00
|
|
|
|
2018-06-28 13:05:57 -07:00
|
|
|
|
|
|
|
|
Troubleshooting
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
In time, all systems have issues that need to be debugged. Troubleshooting
|
|
|
|
|
guides help you find what is broken & hopefully fix it.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
|
|
|
|
troubleshooting/logs
|
2018-06-28 18:26:47 -07:00
|
|
|
|
2018-07-11 13:34:12 -07:00
|
|
|
Often, your issues are not related to TLJH itself but to the cloud provider
|
|
|
|
|
your server is running on. We have some documentation on common issues you
|
|
|
|
|
might run into with various providers and how to fix them. We welcome contributions
|
|
|
|
|
here to better support your favorite provider!
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
|
|
|
|
troubleshooting/providers/google
|
|
|
|
|
|
2018-06-28 18:26:47 -07:00
|
|
|
Contributing
|
|
|
|
|
============
|
|
|
|
|
|
2018-06-29 01:35:19 -07:00
|
|
|
We want you to contribute to TLJH in the ways that are most useful
|
|
|
|
|
and exciting to you. This section contains documentation helpful
|
|
|
|
|
to people contributing in various ways.
|
2018-06-28 18:26:47 -07:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:titlesonly:
|
|
|
|
|
|
2018-07-10 10:21:53 -07:00
|
|
|
contributing/docs
|
2018-07-31 12:36:16 -07:00
|
|
|
contributing/code-review
|
2018-06-28 18:26:47 -07:00
|
|
|
contributing/dev-setup
|
2018-08-12 08:57:03 -07:00
|
|
|
contributing/tests
|
