mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-14 13:33:00 +00:00
Update README
- circle CI no longer used - ubuntu/debian nodejs may be too old (12.0+ required) - remove mention of mailing list - Python 3.6 required - Emphasise JupyterLab over notebook
This commit is contained in:
31
README.md
31
README.md
@@ -24,7 +24,6 @@ For more information, please visit
|
|||||||
[](https://jupyterhub.readthedocs.org/en/latest/)
|
[](https://jupyterhub.readthedocs.org/en/latest/)
|
||||||
[](https://github.com/jupyterhub/jupyterhub/actions)
|
[](https://github.com/jupyterhub/jupyterhub/actions)
|
||||||
[](https://hub.docker.com/r/jupyterhub/jupyterhub/tags)
|
[](https://hub.docker.com/r/jupyterhub/jupyterhub/tags)
|
||||||
[](https://circleci.com/gh/jupyterhub/jupyterhub)<!-- CircleCI Token: b5b65862eb2617b9a8d39e79340b0a6b816da8cc -->
|
|
||||||
[](https://codecov.io/gh/jupyterhub/jupyterhub)
|
[](https://codecov.io/gh/jupyterhub/jupyterhub)
|
||||||
[](https://github.com/jupyterhub/jupyterhub/issues)
|
[](https://github.com/jupyterhub/jupyterhub/issues)
|
||||||
[](https://discourse.jupyter.org/c/jupyterhub)
|
[](https://discourse.jupyter.org/c/jupyterhub)
|
||||||
@@ -65,22 +64,14 @@ for administration of the Hub and its users.
|
|||||||
### Check prerequisites
|
### Check prerequisites
|
||||||
|
|
||||||
- A Linux/Unix based system
|
- A Linux/Unix based system
|
||||||
- [Python](https://www.python.org/downloads/) 3.5 or greater
|
- [Python](https://www.python.org/downloads/) 3.6 or greater
|
||||||
- [nodejs/npm](https://www.npmjs.com/)
|
- [nodejs/npm](https://www.npmjs.com/)
|
||||||
|
|
||||||
- If you are using **`conda`**, the nodejs and npm dependencies will be installed for
|
- If you are using **`conda`**, the nodejs and npm dependencies will be installed for
|
||||||
you by conda.
|
you by conda.
|
||||||
|
|
||||||
- If you are using **`pip`**, install a recent version of
|
- If you are using **`pip`**, install a recent version (at least 12.0) of
|
||||||
[nodejs/npm](https://docs.npmjs.com/getting-started/installing-node).
|
[nodejs/npm](https://docs.npmjs.com/getting-started/installing-node).
|
||||||
For example, install it on Linux (Debian/Ubuntu) using:
|
|
||||||
|
|
||||||
```
|
|
||||||
sudo apt-get install npm nodejs-legacy
|
|
||||||
```
|
|
||||||
|
|
||||||
The `nodejs-legacy` package installs the `node` executable and is currently
|
|
||||||
required for npm to work on Debian/Ubuntu.
|
|
||||||
|
|
||||||
- If using the default PAM Authenticator, a [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module).
|
- If using the default PAM Authenticator, a [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module).
|
||||||
- TLS certificate and key for HTTPS communication
|
- TLS certificate and key for HTTPS communication
|
||||||
@@ -96,12 +87,11 @@ To install JupyterHub along with its dependencies including nodejs/npm:
|
|||||||
conda install -c conda-forge jupyterhub
|
conda install -c conda-forge jupyterhub
|
||||||
```
|
```
|
||||||
|
|
||||||
If you plan to run notebook servers locally, install the Jupyter notebook
|
If you plan to run notebook servers locally, install JupyterLab or Jupyter notebook:
|
||||||
or JupyterLab:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
conda install notebook
|
|
||||||
conda install jupyterlab
|
conda install jupyterlab
|
||||||
|
conda install notebook
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Using `pip`
|
#### Using `pip`
|
||||||
@@ -113,10 +103,10 @@ npm install -g configurable-http-proxy
|
|||||||
python3 -m pip install jupyterhub
|
python3 -m pip install jupyterhub
|
||||||
```
|
```
|
||||||
|
|
||||||
If you plan to run notebook servers locally, you will need to install the
|
If you plan to run notebook servers locally, you will need to install
|
||||||
[Jupyter notebook](https://jupyter.readthedocs.io/en/latest/install.html)
|
[JupyterLab or Jupyter notebook](https://jupyter.readthedocs.io/en/latest/install.html):
|
||||||
package:
|
|
||||||
|
|
||||||
|
python3 -m pip install --upgrade jupyterlab
|
||||||
python3 -m pip install --upgrade notebook
|
python3 -m pip install --upgrade notebook
|
||||||
|
|
||||||
### Run the Hub server
|
### Run the Hub server
|
||||||
@@ -239,13 +229,12 @@ docker container or Linux VM.
|
|||||||
We use a shared copyright model that enables all contributors to maintain the
|
We use a shared copyright model that enables all contributors to maintain the
|
||||||
copyright on their contributions.
|
copyright on their contributions.
|
||||||
|
|
||||||
All code is licensed under the terms of the revised BSD license.
|
All code is licensed under the terms of the [revised BSD license](./COPYING.md).
|
||||||
|
|
||||||
## Help and resources
|
## Help and resources
|
||||||
|
|
||||||
We encourage you to ask questions on the [Jupyter mailing list](https://groups.google.com/forum/#!forum/jupyter).
|
We encourage you to ask questions and share ideas on the [Jupyter community forum](https://discourse.jupyter.org/).
|
||||||
To participate in development discussions or get help, talk with us on
|
You can also talk with us on our JupyterHub [Gitter](https://gitter.im/jupyterhub/jupyterhub) channel.
|
||||||
our JupyterHub [Gitter](https://gitter.im/jupyterhub/jupyterhub) channel.
|
|
||||||
|
|
||||||
- [Reporting Issues](https://github.com/jupyterhub/jupyterhub/issues)
|
- [Reporting Issues](https://github.com/jupyterhub/jupyterhub/issues)
|
||||||
- [JupyterHub tutorial](https://github.com/jupyterhub/jupyterhub-tutorial)
|
- [JupyterHub tutorial](https://github.com/jupyterhub/jupyterhub-tutorial)
|
||||||
|
Reference in New Issue
Block a user