mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-15 14:03:02 +00:00
Merge pull request #4305 from alwasega/tutorials
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
(authenticators)=
|
||||
|
||||
# Authentication and User Basics
|
||||
|
||||
The default Authenticator uses [PAM][] (Pluggable Authentication Module) to authenticate system users with
|
||||
|
@@ -1,3 +1,5 @@
|
||||
(security-basics)=
|
||||
|
||||
# Security settings
|
||||
|
||||
:::{important}
|
||||
|
@@ -51,13 +51,13 @@ follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/
|
||||
Documentation sections (reorganization in-progress)
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
|
||||
faq/index.md
|
||||
tutorial/index.md
|
||||
howto/index.md
|
||||
explanation/index.md
|
||||
reference/index.md
|
||||
faq/index.md
|
||||
```
|
||||
|
||||
(index/distributions)=
|
||||
@@ -81,14 +81,6 @@ Today, you can find two main use cases:
|
||||
_It is important to evaluate these distributions before you can continue with the
|
||||
configuration of JupyterHub_.
|
||||
|
||||
### Installation Guide
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
|
||||
installation-guide
|
||||
```
|
||||
|
||||
### Getting Started
|
||||
|
||||
```{toctree}
|
||||
|
@@ -1,13 +0,0 @@
|
||||
# Installation
|
||||
|
||||
These sections cover how to get up-and-running with JupyterHub. They cover
|
||||
some basics of the tools needed to deploy JupyterHub as well as how to get it
|
||||
running on your own infrastructure.
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 3
|
||||
|
||||
quickstart
|
||||
quickstart-docker
|
||||
installation-basics
|
||||
```
|
@@ -2,7 +2,16 @@
|
||||
|
||||
This section of the documentation provides step-by-step tutorials to help you achieve a specific goal. The tutorials should be a good place to start learning about JupyterHub and how it works.
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
## Installation
|
||||
|
||||
These sections cover how to get up-and-running with JupyterHub. They cover
|
||||
some basics of the tools needed to deploy JupyterHub as well as how to get it
|
||||
running on your own infrastructure.
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
installation/quickstart
|
||||
installation/installation-basics
|
||||
installation/quickstart-docker
|
||||
```
|
||||
|
@@ -6,7 +6,7 @@ JupyterHub is supported on Linux/Unix based systems. To use JupyterHub, you need
|
||||
a Unix server (typically Linux) running somewhere that is accessible to your
|
||||
team on the network. The JupyterHub server can be on an internal network at your
|
||||
organization, or it can run on the public internet (in which case, take care
|
||||
with the Hub's [security](./getting-started/security-basics)).
|
||||
with the Hub's [security](security-basics)).
|
||||
|
||||
JupyterHub officially **does not** support Windows. You may be able to use
|
||||
JupyterHub on Windows if you use a Spawner and Authenticator that work on
|
@@ -27,7 +27,7 @@ Before installing JupyterHub, you will need:
|
||||
if your system package manager only has an old version of Node.js (e.g. 10 or older).
|
||||
|
||||
- A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module)
|
||||
to use the [default Authenticator](./getting-started/authenticators-users-basics.md).
|
||||
to use the [default Authenticator](authenticators).
|
||||
PAM is often available by default on most distributions, if this is not the case it can be installed by
|
||||
using the operating system's package manager.
|
||||
- TLS certificate and key for HTTPS communication
|
Reference in New Issue
Block a user