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-10-30 20:08:47 -07:00
|
|
|
|
2018-07-12 14:15:01 -07:00
|
|
|
Development Status
|
|
|
|
|
==================
|
|
|
|
|
|
2019-05-09 13:08:02 -07:00
|
|
|
This project is currently in **beta** state. Folks have been using installations
|
|
|
|
|
of TLJH for more than a year now to great success. While we try hard not to, we
|
|
|
|
|
might still make breaking changes that have no clear upgrade pathway.
|
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
|
2018-10-30 20:08:47 -07:00
|
|
|
**Ubuntu 18.04**. Earlier versions of Ubuntu are not supported.
|
|
|
|
|
We have a bunch of tutorials to get you started.
|
2018-07-11 12:00:58 -07:00
|
|
|
|
|
|
|
|
- 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:
|
2019-11-26 18:42:42 -08:00
|
|
|
:maxdepth: 2
|
2018-07-11 12:00:58 -07:00
|
|
|
|
2019-11-26 18:42:42 -08:00
|
|
|
install/index
|
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,
|
2018-08-10 10:09:24 -07:00
|
|
|
it's a good idea to proceed directly to :doc:`howto/admin/https`.
|
2018-07-30 16:08:47 +02:00
|
|
|
|
2018-08-10 10:09:24 -07:00
|
|
|
How-To Guides
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
How-To guides answer the question 'How do I...?' for a lot of topics.
|
2018-07-26 23:47:07 -07:00
|
|
|
|
2018-07-10 14:39:26 -07:00
|
|
|
.. toctree::
|
2019-11-26 18:42:42 -08:00
|
|
|
:maxdepth: 2
|
2018-07-10 14:39:26 -07:00
|
|
|
|
2019-11-26 18:42:42 -08:00
|
|
|
howto/index
|
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:
|
2019-11-26 18:42:42 -08:00
|
|
|
:maxdepth: 2
|
2018-06-28 00:39:55 -07:00
|
|
|
|
2019-11-26 18:42:42 -08:00
|
|
|
topic/index
|
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:
|
2019-11-26 18:42:42 -08:00
|
|
|
:maxdepth: 2
|
2018-06-28 18:26:47 -07:00
|
|
|
|
2019-11-26 18:42:42 -08:00
|
|
|
troubleshooting/index
|
2018-07-11 13:34:12 -07:00
|
|
|
|
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:
|
2019-11-26 18:42:42 -08:00
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
contributing/index
|
