zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Normalize heading levels to match documentation guidelines

Browse Source
This commit is contained in:
yuvipanda
2018-07-10 11:35:18 -07:00
parent 13dcd2f871
commit 35517aab5c
11 changed files with 47 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/guides/admin.rst
View File

@@ -1,7 +1,8 @@
.. _admin_access:
=====================
Administrative Access
---------------------
=====================
In The Littlest JupyterHub, we try to allow users to do as many administrative
tasks as possible within JupyterHub itself. Admin users can:

5
docs/guides/install.rst
View File

@@ -1,10 +1,11 @@
.. _installation:
============
Installation
============
Quick Installation
------------------
==================
The quick way to install The Littlest JupyterHub (tljh) is:
@@ -19,7 +20,7 @@ You should probably add yourself as an `admin user <admin.rst>`_
after installation.
Slightly less quick installation
--------------------------------
================================
If you can read ``python3`` and are nervous about the previous installation method,
you can inspect the installer script before running it.

5
docs/guides/notebook-interfaces.rst
View File

@@ -1,5 +1,6 @@
.. _notebook_interfaces:
==================================================
Notebook Interfaces (Classic, JupyterLab, nteract)
==================================================
@@ -14,7 +15,7 @@ Both these interfaces are also shipped with tljh by default. You can try them
temporarily, or set them to be the default interface whenever you login.
Trying alternate interface tempoarily
-------------------------------------
=====================================
When you log in & start your server, by default the URL in your browser
will be something like ``/user/<username>/tree``. The ``/tree`` is what tells
@@ -26,7 +27,7 @@ the notebook server to give you the classic notebook interface.
You can play around with them and see what fits your use cases best.
Changing the default user interface
-----------------------------------
===================================
You can change the default interface users get when they log in by modifying
``config.yaml`` as an admin user.

9
docs/guides/requirements.rst
View File

@@ -1,23 +1,24 @@
.. _requirements:
===================
Server Requirements
===================
Operating System
----------------
================
We recommend using Ubuntu 18.04 as the base operating system for your server.
Ubuntu 16.04 should also work, but is not officially supported. other Linux
distributions and operating systems are also not officially supported.
Root access
-----------
===========
Full ``root`` access to this server is required. This might be via ``sudo``
(recommended) or by direct access to ``root`` (not recommended!)
External IP
-----------
===========
An external IP allows users on the internet to reach your JupyterHub. Most
VPS / Cloud providers give you a public IP address along with your server. If
@@ -25,7 +26,7 @@ you are hosting on a physical machine somewhere, talk to your system administrat
about how to get HTTP traffic from the world into your server.
Memory (RAM)
------------
============
RAM is often the biggest limiting factor to the question 'how many users can use this JupyterHub
at the same time?'. If you want to support ``N`` maximum concurrent active users

11
docs/guides/user-environment.rst
View File

@@ -1,5 +1,6 @@
.. _user_environment:
============================
Customizing user environment
============================
@@ -11,7 +12,7 @@ easily.
.. _user_environment_pip:
Installing pip packages
-----------------------
=======================
`pip <https://pypi.org/project/pip/>`_ is the recomended tool for installing packages
in Python from the `Python Packaging Index (PyPI) <https://pypi.org/>`_. PyPI has
@@ -41,7 +42,7 @@ almost 145,000 packages in it right now, so a lot of what you need is going to b
.. _user_environment_conda:
Installing conda packages
-------------------------
=========================
Conda lets you install new languages (such as new versions of python, node, R, etc)
as well as packages in those languages. For lots of scientific software, installing
@@ -75,7 +76,7 @@ a community maintained repository of conda packages.
.. _user_environment_apt:
Installing apt packages
-----------------------
=======================
`apt <https://help.ubuntu.com/lts/serverguide/apt.html.en>`_ is the official package
manager for the `Ubuntu Linux distribution <https://www.ubuntu.com/>`_. You can install
@@ -112,7 +113,7 @@ make sure to look in the version of Ubuntu you are using!
User environment location
-------------------------
=========================
The user environment is a conda enviornment set up in ``/opt/tljh/user``, with
a Python3 kernel as the default. It is readable by all users, but writeable only
@@ -120,7 +121,7 @@ by users who have root access. This makes it possible for JupyterHub admins (who
root access with ``sudo``) to install software in the user environment easily.
Accessing user environment outside JupyterHub
---------------------------------------------
=============================================
We add ``/opt/tljh/user/bin`` to the ``$PATH`` environment variable for all JupyterHub
users, so everything installed in the user environment is available to them automatically.