Files
the-littlest-jupyterhub/docs/index.rst
yuvipanda 715860707b Rewrite bootstrapper in Python
- This was going to get too complex for bash. Only way to
  kill those scripts is before they get too complex.
- Better progress messages from bootstrapper.
- Differentiate between bootstrapper & installer
- Cleanup documentation a little bit
2018-07-02 15:12:26 -07:00

69 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.
Quick Start
===========
On a fresh Ubuntu 18.04 server, you can install The Littlest JupyterHub with:
.. code-block:: bash
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/bootstrap/bootstrap.py | sudo python3 -
This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
at the public IP of your server! Read the :ref:`tutorial_quickstart` next.
If this installation method (``curl <arbitrary-url> | sudo bash -``)
makes you nervous, check out the :ref:`other installation methods <installation>` we support!
Tutorials
=========
Tutorials guide you through accomplishing specific goals. Great place to get
started!
.. toctree::
:titlesonly:
tutorials/quickstart
Guides
======
Guides provide in-depth explanations of specific topics.
.. toctree::
:titlesonly:
guides/requirements
guides/install
guides/admin
guides/user-environment
guides/notebook-interfaces
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/dev-setup