Files
the-littlest-jupyterhub/README.rst
yuvipanda 84e945367d Make README better
- Mark develpment status clearly
- Link to tutorials directly
2018-07-11 10:37:05 -07:00

47 lines
2.1 KiB
ReStructuredText

=======================
The Littlest JupyterHub
=======================
.. image:: https://circleci.com/gh/yuvipanda/the-littlest-jupyterhub.svg?style=shield
:target: https://circleci.com/gh/yuvipanda/the-littlest-jupyterhub
.. image:: https://media.readthedocs.org/static/projects/badges/passing-flat.svg
:target: https://the-littlest-jupyterhub.readthedocs.io
.. image:: https://badges.gitter.im/jupyterhub/jupyterhub.svg
:target: https://gitter.im/jupyterhub/jupyterhub
**The Littlest JupyterHub** (TLJH) distribution helps you provide Jupyter Notebooks
to 1-50 users on a single server.
Administrators who do not consider themselves 'system administrators' but would
like to provide hosted Jupyter Notebooks for their students / users are the
primary audience. All users get the same environment, and administrators can
install libraries into this environment without any specialized knowledge.
It provides all users with the same environment, and administrators can install
libraries into this environment easily without any specialized knowledge.
See `this blog post <http://words.yuvi.in/post/the-littlest-jupyterhub/>`_ for
more information.
Development Status
==================
This project is currently in **pre-alpha**, and things will break all the time.
However, feedback at this time is extremely valuble, so you should still try
it out!
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!
- `Tutorial for installing TLJH on your own server that is already running.
<http://the-littlest-jupyterhub.readthedocs.io/en/latest/tutorials/custom.html>`_
- Tutorials for creating a new server & setting up TLJH on it in various
cloud providers:
- `Digital Ocean <http://the-littlest-jupyterhub.readthedocs.io/en/latest/tutorials/digitalocean.html>`_
- `Google Cloud <http://the-littlest-jupyterhub.readthedocs.io/en/latest/tutorials/google.html>`_
- `Jetstream <http://the-littlest-jupyterhub.readthedocs.io/en/latest/tutorials/jetstream.html>`_
- ... more, if you add them! :)