mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Add docs with mkdocs
There isn't going to be much code generation here, so let's start with mkdocs and see if it is good enough for us!
This commit is contained in:
23
docs/index.md
Normal file
23
docs/index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# 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:
|
||||
|
||||
```bash
|
||||
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash | sudo bash -
|
||||
```
|
||||
|
||||
This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
|
||||
at the public IP of your server!
|
||||
|
||||
If this installation method (`curl <arbitrary-url> | sudo bash -`)
|
||||
makes you nervous, check out the [other installation methods](install.md) we support!
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Server requirements](requirements.md)
|
||||
- [Installation](install.md)
|
||||
32
docs/install.md
Normal file
32
docs/install.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Installation
|
||||
|
||||
## Quick Installation
|
||||
The quick way to install The Littlest JupyterHub (tljh) is:
|
||||
|
||||
```bash
|
||||
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash | sudo bash -
|
||||
```
|
||||
|
||||
This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
|
||||
at the public IP of your server!
|
||||
|
||||
## Slightly less quick installation
|
||||
|
||||
If you can read `bash` and are nervous about the previous installation method,
|
||||
you can inspect the installer script before running it.
|
||||
|
||||
1. Download the installer script
|
||||
|
||||
```bash
|
||||
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash -o install.bash
|
||||
```
|
||||
|
||||
2. Read the install script source using your favorite text editor
|
||||
|
||||
3. Run the installer script
|
||||
|
||||
```bash
|
||||
sudo install.bash
|
||||
```
|
||||
|
||||
This should have the exact same effects as the quick installer method.
|
||||
11
docs/requirements.md
Normal file
11
docs/requirements.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Server Requirements
|
||||
|
||||
The Littlest JupyterHub (TLJH) can run on servers that meet at least he following criteria:
|
||||
|
||||
1. Ubuntu Linux Operating System (minimum version supported 18.04)
|
||||
2. Full root access
|
||||
3. Access to the internet
|
||||
4. At least 512MB of RAM
|
||||
|
||||
While TLJH will run on machines that meet these requirements, you should also
|
||||
consider how much resources your individual users need before acquiring a server.
|
||||
2
mkdocs.yml
Normal file
2
mkdocs.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
site_name: The Littlest JupyterHub
|
||||
theme: readthedocs
|
||||
Reference in New Issue
Block a user