Files
the-littlest-jupyterhub/docs/index.rst
2018-07-11 12:10:45 -07:00

74 lines
1.6 KiB
ReStructuredText

=======================
The Littlest JupyterHub
=======================
A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
a small (0-50) number of users on a single server.
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:
tutorials/digitalocean
tutorials/jetstream
tutorials/google
- :ref:`tutorial/custom`.
You should use this if your cloud provider does not already have a direct tutorial,
or if you have experience setting up servers.
How-To Guides
=============
How-To guides answer the question 'How do I...?' for a lot of topics.
.. toctree::
:titlesonly:
howto/user-environment
howto/notebook-interfaces
Guides
======
Guides provide in-depth explanations of specific topics.
.. toctree::
:titlesonly:
guides/requirements
guides/admin
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
Contributing
============
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.
.. toctree::
:titlesonly:
contributing/docs
contributing/dev-setup