hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-16 22:42:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update the tag in docs

Browse Source
This commit is contained in:
Ayaz Salikhov
2022-01-21 13:58:08 +02:00
parent b418b67c22
commit 3306119c2d
8 changed files with 25 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -13,14 +13,13 @@ containing Jupyter applications and interactive computing tools.
You can try a [relatively recent build of the jupyter/base-notebook image on mybinder.org](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb) You can try a [relatively recent build of the jupyter/base-notebook image on mybinder.org](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb)
by simply clicking the preceding link. by simply clicking the preceding link.
The image used in binder was last updated on 22 May 2021.
Otherwise, three examples below may help you get started if you [have Docker installed](https://docs.docker.com/install/), Otherwise, three examples below may help you get started if you [have Docker installed](https://docs.docker.com/install/),
know [which Docker image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you want to use know [which Docker image](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you want to use
and want to launch a single Jupyter Server in a container. and want to launch a single Jupyter Server in a container.
The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail. The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail.
**Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host. **Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `b418b67c225b` from Docker Hub if it is not already present on the local host.
It then starts a container running a Jupyter Server and exposes the server on host port 8888. It then starts a container running a Jupyter Server and exposes the server on host port 8888.
The server logs appear in the terminal. The server logs appear in the terminal.
Visiting `http://<hostname>:8888/?token=<token>` in a browser loads JupyterLab, Visiting `http://<hostname>:8888/?token=<token>` in a browser loads JupyterLab,
@@ -28,7 +27,7 @@ where `hostname` is the name of the computer running docker and `token` is the s
The container remains intact for restart after the Jupyter Server exits. The container remains intact for restart after the Jupyter Server exits.
```bash ```bash
docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64 docker run -p 8888:8888 jupyter/scipy-notebook:b418b67c225b
``` ```
**Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888. **Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888.
@@ -36,10 +35,10 @@ Visiting `http://<hostname>:10000/?token=<token>` in a browser loads JupyterLab,
where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console. where `hostname` is the name of the computer running docker and `token` is the secret token printed in the console.
```bash ```bash
docker run -p 10000:8888 jupyter/scipy-notebook:33add21fab64 docker run -p 10000:8888 jupyter/scipy-notebook:b418b67c225b
``` ```
**Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host. **Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `b418b67c225b` from Docker Hub if it is not already present on the local host.
It then starts an _ephemeral_ container running a Jupyter Server and exposes the server on host port 10000. It then starts an _ephemeral_ container running a Jupyter Server and exposes the server on host port 10000.
The command mounts the current working directory on the host as `/home/jovyan/work` in the container. The command mounts the current working directory on the host as `/home/jovyan/work` in the container.
The server logs appear in the terminal. The server logs appear in the terminal.
@@ -48,7 +47,7 @@ where `hostname` is the name of the computer running docker and `token` is the s
Docker destroys the container after Jupyter Server exit, but any files written to `~/work` in the container remain intact on the host. Docker destroys the container after Jupyter Server exit, but any files written to `~/work` in the container remain intact on the host.
```bash ```bash
docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64 docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:b418b67c225b
``` ```
## Contributing ## Contributing

4
binder/Dockerfile
View File

@@ -3,11 +3,11 @@
# https://hub.docker.com/r/jupyter/base-notebook/tags # https://hub.docker.com/r/jupyter/base-notebook/tags
ARG OWNER=jupyter ARG OWNER=jupyter
ARG BASE_CONTAINER=$OWNER/base-notebook:33add21fab64 ARG BASE_CONTAINER=$OWNER/base-notebook:b418b67c225b
FROM $BASE_CONTAINER FROM $BASE_CONTAINER
LABEL maintainer="Jupyter Project <jupyter@googlegroups.com>" LABEL maintainer="Jupyter Project <jupyter@googlegroups.com>"
ENV TAG="33add21fab64" ENV TAG="b418b67c225b"
WORKDIR "${HOME}" WORKDIR "${HOME}"
COPY binder/README.ipynb . COPY binder/README.ipynb .

10
docs/index.rst
View File

@@ -19,22 +19,22 @@ and want to launch a single Jupyter Server in a container.
The other pages in this documentation describe additional uses and features in detail. The other pages in this documentation describe additional uses and features in detail.
**Example 1:** This command pulls the ``jupyter/scipy-notebook`` image tagged ``33add21fab64`` from Docker Hub if it is not already present on the local host. **Example 1:** This command pulls the ``jupyter/scipy-notebook`` image tagged ``b418b67c225b`` from Docker Hub if it is not already present on the local host.
It then starts a container running a Jupyter Server and exposes the server on host port 8888. It then starts a container running a Jupyter Server and exposes the server on host port 8888.
The server logs appear in the terminal. The server logs appear in the terminal.
Visiting ``http://<hostname>:8888/?token=<token>`` in a browser loads JupyterLab, Visiting ``http://<hostname>:8888/?token=<token>`` in a browser loads JupyterLab,
where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console. where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console.
The container remains intact for restart after the Jupyter Server exits.:: The container remains intact for restart after the Jupyter Server exits.::
docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64 docker run -p 8888:8888 jupyter/scipy-notebook:b418b67c225b
**Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888. **Example 2:** This command performs the same operations as **Example 1**, but it exposes the server on host port 10000 instead of port 8888.
Visiting ``http://<hostname>:10000/?token=<token>`` in a browser loads JupyterLab, Visiting ``http://<hostname>:10000/?token=<token>`` in a browser loads JupyterLab,
where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console.:: where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console.::
docker run -p 10000:8888 jupyter/scipy-notebook:33add21fab64 docker run -p 10000:8888 jupyter/scipy-notebook:b418b67c225b
**Example 3:** This command pulls the ``jupyter/datascience-notebook`` image tagged ``33add21fab64`` from Docker Hub if it is not already present on the local host. **Example 3:** This command pulls the ``jupyter/datascience-notebook`` image tagged ``b418b67c225b`` from Docker Hub if it is not already present on the local host.
It then starts an *ephemeral* container running a Jupyter Server and exposes the server on host port 10000. It then starts an *ephemeral* container running a Jupyter Server and exposes the server on host port 10000.
The command mounts the current working directory on the host as ``/home/jovyan/work`` in the container. The command mounts the current working directory on the host as ``/home/jovyan/work`` in the container.
The server logs appear in the terminal. The server logs appear in the terminal.
@@ -42,7 +42,7 @@ Visiting ``http://<hostname>:10000/lab?token=<token>`` in a browser loads Jupyte
where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console. where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console.
Docker destroys the container after Jupyter Server exit, but any files written to ``~/work`` in the container remain intact on the host.:: Docker destroys the container after Jupyter Server exit, but any files written to ``~/work`` in the container remain intact on the host.::
docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64 docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:b418b67c225b
CPU Architectures CPU Architectures
----------------- -----------------

12
docs/using/recipes.md
View File

@@ -27,7 +27,7 @@ Create a new Dockerfile like the one shown below.
```dockerfile ```dockerfile
# Start from a core stack version # Start from a core stack version
FROM jupyter/datascience-notebook:33add21fab64 FROM jupyter/datascience-notebook:b418b67c225b
# Install in the default python3 environment # Install in the default python3 environment
RUN pip install --quiet --no-cache-dir 'flake8==3.9.2' && \ RUN pip install --quiet --no-cache-dir 'flake8==3.9.2' && \
fix-permissions "${CONDA_DIR}" && \ fix-permissions "${CONDA_DIR}" && \
@@ -46,7 +46,7 @@ Next, create a new Dockerfile like the one shown below.
```dockerfile ```dockerfile
# Start from a core stack version # Start from a core stack version
FROM jupyter/datascience-notebook:33add21fab64 FROM jupyter/datascience-notebook:b418b67c225b
# Install from requirements.txt file # Install from requirements.txt file
COPY --chown=${NB_UID}:${NB_GID} requirements.txt /tmp/ COPY --chown=${NB_UID}:${NB_GID} requirements.txt /tmp/
RUN pip install --quiet --no-cache-dir --requirement /tmp/requirements.txt && \ RUN pip install --quiet --no-cache-dir --requirement /tmp/requirements.txt && \
@@ -58,7 +58,7 @@ For conda, the Dockerfile is similar:
```dockerfile ```dockerfile
# Start from a core stack version # Start from a core stack version
FROM jupyter/datascience-notebook:33add21fab64 FROM jupyter/datascience-notebook:b418b67c225b
# Install from requirements.txt file # Install from requirements.txt file
COPY --chown=${NB_UID}:${NB_GID} requirements.txt /tmp/ COPY --chown=${NB_UID}:${NB_GID} requirements.txt /tmp/
RUN mamba install --yes --file /tmp/requirements.txt && \ RUN mamba install --yes --file /tmp/requirements.txt && \
@@ -311,7 +311,7 @@ To use a specific version of JupyterHub, the version of `jupyterhub` in your ima
version in the Hub itself. version in the Hub itself.
```dockerfile ```dockerfile
FROM jupyter/base-notebook:33add21fab64 FROM jupyter/base-notebook:b418b67c225b
RUN pip install --quiet --no-cache-dir jupyterhub==1.4.1 && \ RUN pip install --quiet --no-cache-dir jupyterhub==1.4.1 && \
fix-permissions "${CONDA_DIR}" && \ fix-permissions "${CONDA_DIR}" && \
fix-permissions "/home/${NB_USER}" fix-permissions "/home/${NB_USER}"
@@ -485,13 +485,13 @@ In this case, you should use the `start.sh` script to launch the server with no
For jupyterlab: For jupyterlab:
```bash ```bash
docker run jupyter/base-notebook:33add21fab64 start.sh jupyter lab --LabApp.token='' docker run jupyter/base-notebook:b418b67c225b start.sh jupyter lab --LabApp.token=''
``` ```
For jupyter classic: For jupyter classic:
```bash ```bash
docker run jupyter/base-notebook:33add21fab64 start.sh jupyter notebook --NotebookApp.token='' docker run jupyter/base-notebook:b418b67c225b start.sh jupyter notebook --NotebookApp.token=''
``` ```
## Enable nbextension spellchecker for markdown (or any other nbextension) ## Enable nbextension spellchecker for markdown (or any other nbextension)

8
docs/using/running.md
View File

@@ -13,12 +13,12 @@ You can launch a local Docker container from the Jupyter Docker Stacks using the
There are numerous ways to configure containers using the CLI. There are numerous ways to configure containers using the CLI.
The following are some common patterns. The following are some common patterns.
**Example 1** This command pulls the `jupyter/scipy-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host. **Example 1** This command pulls the `jupyter/scipy-notebook` image tagged `b418b67c225b` from Docker Hub if it is not already present on the local host.
It then starts a container running a Jupyter Notebook server and exposes the server on host port 8888. It then starts a container running a Jupyter Notebook server and exposes the server on host port 8888.
The server logs appear in the terminal and include a URL to the notebook server. The server logs appear in the terminal and include a URL to the notebook server.
```bash ```bash
$ docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64 $ docker run -p 8888:8888 jupyter/scipy-notebook:b418b67c225b
Executing the command: jupyter notebook Executing the command: jupyter notebook
[I 15:33:00.567 NotebookApp] Writing notebook server cookie secret to /home/jovyan/.local/share/jupyter/runtime/notebook_cookie_secret [I 15:33:00.567 NotebookApp] Writing notebook server cookie secret to /home/jovyan/.local/share/jupyter/runtime/notebook_cookie_secret
@@ -56,12 +56,12 @@ $ docker rm d67fe77f1a84
d67fe77f1a84 d67fe77f1a84
``` ```
**Example 2** This command pulls the `jupyter/r-notebook` image tagged `33add21fab64` from Docker Hub if it is not already present on the local host. **Example 2** This command pulls the `jupyter/r-notebook` image tagged `b418b67c225b` from Docker Hub if it is not already present on the local host.
It then starts a container running a Jupyter Notebook server and exposes the server on host port 10000. It then starts a container running a Jupyter Notebook server and exposes the server on host port 10000.
The server logs appear in the terminal and include a URL to the notebook server, but with the internal container port (8888) instead of the the correct host port (10000). The server logs appear in the terminal and include a URL to the notebook server, but with the internal container port (8888) instead of the the correct host port (10000).
```bash ```bash
$ docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/r-notebook:33add21fab64 $ docker run --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work jupyter/r-notebook:b418b67c225b
Executing the command: jupyter notebook Executing the command: jupyter notebook
[I 19:31:09.573 NotebookApp] Writing notebook server cookie secret to /home/jovyan/.local/share/jupyter/runtime/notebook_cookie_secret [I 19:31:09.573 NotebookApp] Writing notebook server cookie secret to /home/jovyan/.local/share/jupyter/runtime/notebook_cookie_secret

2
examples/docker-compose/README.md
View File

@@ -42,7 +42,7 @@ You can customize the docker-stack notebook image to deploy by modifying the `no
For example, you can build and deploy a `jupyter/all-spark-notebook` by modifying the Dockerfile like so: For example, you can build and deploy a `jupyter/all-spark-notebook` by modifying the Dockerfile like so:
```dockerfile ```dockerfile
FROM jupyter/all-spark-notebook:33add21fab64 FROM jupyter/all-spark-notebook:b418b67c225b
... ...
``` ```

2
examples/docker-compose/notebook/Dockerfile
View File

@@ -2,7 +2,7 @@
# Distributed under the terms of the Modified BSD License. # Distributed under the terms of the Modified BSD License.
# Pick your favorite docker-stacks image # Pick your favorite docker-stacks image
FROM jupyter/minimal-notebook:33add21fab64 FROM jupyter/minimal-notebook:b418b67c225b
USER root USER root

2
examples/make-deploy/Dockerfile
View File

@@ -2,7 +2,7 @@
# Distributed under the terms of the Modified BSD License. # Distributed under the terms of the Modified BSD License.
# Pick your favorite docker-stacks image # Pick your favorite docker-stacks image
FROM jupyter/minimal-notebook:33add21fab64 FROM jupyter/minimal-notebook:b418b67c225b
USER root USER root