mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-18 07:23:00 +00:00
Merge pull request #1949 from willingc/npm-doc
clarify that conda installs npm and proxy
This commit is contained in:
45
README.md
45
README.md
@@ -50,37 +50,62 @@ for administration of the Hub and its users.
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
### Check prerequisites
|
||||
|
||||
A Linux/Unix based system with the following:
|
||||
- A Linux/Unix based system
|
||||
- [Python](https://www.python.org/downloads/) 3.5 or greater
|
||||
- [nodejs/npm](https://www.npmjs.com/)
|
||||
|
||||
- [Python](https://www.python.org/downloads/) 3.4 or greater
|
||||
- [nodejs/npm](https://www.npmjs.com/) Install a recent version of
|
||||
[nodejs/npm](https://docs.npmjs.com/getting-started/installing-node)
|
||||
For example, install it on Linux (Debian/Ubuntu) using:
|
||||
* If you are using **`conda`**, the nodejs and npm dependencies will be installed for
|
||||
you by conda.
|
||||
|
||||
sudo apt-get install npm nodejs-legacy
|
||||
* If you are using **`pip`**, install a recent version of
|
||||
[nodejs/npm](https://docs.npmjs.com/getting-started/installing-node).
|
||||
For example, install it on Linux (Debian/Ubuntu) using:
|
||||
|
||||
The `nodejs-legacy` package installs the `node` executable and is currently
|
||||
required for npm to work on Debian/Ubuntu.
|
||||
```
|
||||
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.
|
||||
|
||||
- TLS certificate and key for HTTPS communication
|
||||
- Domain name
|
||||
|
||||
### Install packages
|
||||
|
||||
#### Using `conda`
|
||||
|
||||
To install JupyterHub along with its dependencies including nodejs/npm:
|
||||
|
||||
```bash
|
||||
conda install jupyterhub
|
||||
```
|
||||
|
||||
If you plan to run notebook servers locally, install the Jupyter notebook
|
||||
or JupyterLab:
|
||||
|
||||
```bash
|
||||
conda install notebook
|
||||
conda install jupyterlab
|
||||
```
|
||||
|
||||
#### Using `pip`
|
||||
|
||||
JupyterHub can be installed with `pip`, and the proxy with `npm`:
|
||||
|
||||
```bash
|
||||
npm install -g configurable-http-proxy
|
||||
pip3 install jupyterhub
|
||||
python3 -m pip install jupyterhub
|
||||
```
|
||||
|
||||
If you plan to run notebook servers locally, you will need to install the
|
||||
[Jupyter notebook](https://jupyter.readthedocs.io/en/latest/install.html)
|
||||
package:
|
||||
|
||||
pip3 install --upgrade notebook
|
||||
python3 -m pip install --upgrade notebook
|
||||
|
||||
### Run the Hub server
|
||||
|
||||
|
@@ -5,20 +5,27 @@
|
||||
Before installing JupyterHub, you will need:
|
||||
|
||||
- a Linux/Unix based system
|
||||
- [Python](https://www.python.org/downloads/) 3.4 or greater. An understanding
|
||||
- [Python](https://www.python.org/downloads/) 3.5 or greater. An understanding
|
||||
of using [`pip`](https://pip.pypa.io/en/stable/) or
|
||||
[`conda`](https://conda.io/docs/get-started.html) for
|
||||
installing Python packages is helpful.
|
||||
- [nodejs/npm](https://www.npmjs.com/). [Install nodejs/npm](https://docs.npmjs.com/getting-started/installing-node),
|
||||
using your operating system's package manager. For example, install on Linux
|
||||
Debian/Ubuntu using:
|
||||
using your operating system's package manager.
|
||||
|
||||
```bash
|
||||
sudo apt-get install npm nodejs-legacy
|
||||
```
|
||||
* If you are using **`conda`**, the nodejs and npm dependencies will be installed for
|
||||
you by conda.
|
||||
|
||||
* If you are using **`pip`**, install a recent version of
|
||||
[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.
|
||||
|
||||
The `nodejs-legacy` package installs the `node` executable and is currently
|
||||
required for `npm` to work on Debian/Ubuntu.
|
||||
- TLS certificate and key for HTTPS communication
|
||||
- Domain name
|
||||
|
||||
|
Reference in New Issue
Block a user