|
5 | 5 |
|
6 | 6 | # Jupyter Docker Stacks
|
7 | 7 |
|
8 |
| -Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter) containing Jupyter applications and interactive computing tools. |
| 8 | +Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter) |
| 9 | +containing Jupyter applications and interactive computing tools. |
| 10 | + |
| 11 | +## Maintainer Help Wanted |
| 12 | + |
| 13 | +We value all positive contributions to the Docker stacks project, from |
| 14 | +[bug reports](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/issues.html) to |
| 15 | +[pull requests](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/packages.html) |
| 16 | +to |
| 17 | +[translations](https://jupyter-docker-stacks.readthedocs.io/en/latest/contributing/translations.html) |
| 18 | +to help answering questions. We'd also like to invite members of the community to help with two |
| 19 | +maintainer activities: |
| 20 | + |
| 21 | +- Issue triage: Reading and providing a first response to issues, labeling issues appropriately, |
| 22 | + redirecting cross-project questions to Jupyter Discourse |
| 23 | +- Pull request reviews: Reading proposed documentation and code changes, working with the submitter |
| 24 | + to improve the contribution, deciding if the contribution should take another form (e.g., a recipe |
| 25 | + instead of a permanent change to the images) |
| 26 | + |
| 27 | +Anyone in the community can jump in and help with these activities at any time. We will happily |
| 28 | +grant additional permissions (e.g., ability to merge PRs) to anyone who shows an on-going interest |
| 29 | +in working on the project. |
9 | 30 |
|
10 | 31 | ## Quick Start
|
11 | 32 |
|
12 |
| -You can try a [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. Otherwise, the two examples below may help you get started if you [have Docker installed](https://docs.docker.com/install/) know [which Docker image](http://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you want to use, and want to launch a single Jupyter Notebook server in a container. |
| 33 | +You can try a |
| 34 | +[recent build of the jupyter/base-notebook image on mybinder.org](https://mybinder.org/v2/gh/jupyter/docker-stacks/master?filepath=README.ipynb) |
| 35 | +by simply clicking the preceding link. Otherwise, the two examples below may help you get started if |
| 36 | +you [have Docker installed](https://docs.docker.com/install/) know |
| 37 | +[which Docker image](http://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html) you |
| 38 | +want to use, and want to launch a single Jupyter Notebook server in a container. |
13 | 39 |
|
14 |
| -The [User Guide on ReadTheDocs](http://jupyter-docker-stacks.readthedocs.io/) describes additional uses and features in detail. |
| 40 | +The [User Guide on ReadTheDocs](http://jupyter-docker-stacks.readthedocs.io/) describes additional |
| 41 | +uses and features in detail. |
15 | 42 |
|
16 |
| -**Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `17aba6048f44` 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. The server logs appear in the terminal. Visiting `http://<hostname>:8888/?token=<token>` in a browser loads the Jupyter Notebook dashboard page, 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 notebook server exits. |
| 43 | +**Example 1:** This command pulls the `jupyter/scipy-notebook` image tagged `17aba6048f44` from |
| 44 | +Docker Hub if it is not already present on the local host. It then starts a container running a |
| 45 | +Jupyter Notebook server and exposes the server on host port 8888. The server logs appear in the |
| 46 | +terminal. Visiting `http://<hostname>:8888/?token=<token>` in a browser loads the Jupyter Notebook |
| 47 | +dashboard page, where `hostname` is the name of the computer running docker and `token` is the |
| 48 | +secret token printed in the console. The container remains intact for restart after the notebook |
| 49 | +server exits. |
17 | 50 |
|
18 | 51 | docker run -p 8888:8888 jupyter/scipy-notebook:17aba6048f44
|
19 | 52 |
|
20 |
| -**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, where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console.:: |
| 53 | +**Example 2:** This command performs the same operations as **Example 1**, but it exposes the server |
| 54 | +on host port 10000 instead of port 8888. Visiting `http://<hostname>:10000/?token=<token>` in a |
| 55 | +browser loads JupyterLab, where `hostname` is the name of the computer running docker and `token` is |
| 56 | +the secret token printed in the console.:: |
21 | 57 |
|
22 | 58 | docker run -p 10000:8888 jupyter/scipy-notebook:17aba6048f44
|
23 | 59 |
|
24 |
| -**Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `9b06df75e445` from Docker Hub if it is not already present on the local host. It then starts an *ephemeral* container running a Jupyter Notebook 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 server logs appear in the terminal. 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. Docker destroys the container after notebook server exit, but any files written to `~/work` in the container remain intact on the host. |
| 60 | +**Example 3:** This command pulls the `jupyter/datascience-notebook` image tagged `9b06df75e445` |
| 61 | +from Docker Hub if it is not already present on the local host. It then starts an _ephemeral_ |
| 62 | +container running a Jupyter Notebook server and exposes the server on host port 10000. The command |
| 63 | +mounts the current working directory on the host as `/home/jovyan/work` in the container. The server |
| 64 | +logs appear in the terminal. Visiting `http://<hostname>:10000/?token=<token>` in a browser loads |
| 65 | +JupyterLab, where `hostname` is the name of the computer running docker and `token` is the secret |
| 66 | +token printed in the console. Docker destroys the container after notebook server exit, but any |
| 67 | +files written to `~/work` in the container remain intact on the host. |
25 | 68 |
|
26 | 69 | docker run --rm -p 10000:8888 -e JUPYTER_ENABLE_LAB=yes -v "$PWD":/home/jovyan/work jupyter/datascience-notebook:9b06df75e445
|
27 | 70 |
|
28 | 71 | ## Contributing
|
29 | 72 |
|
30 |
| -Please see the [Contributor Guide on ReadTheDocs](http://jupyter-docker-stacks.readthedocs.io/) for information about how to contribute package updates, recipes, features, tests, and community maintained stacks. |
| 73 | +Please see the [Contributor Guide on ReadTheDocs](http://jupyter-docker-stacks.readthedocs.io/) for |
| 74 | +information about how to contribute package updates, recipes, features, tests, and community |
| 75 | +maintained stacks. |
31 | 76 |
|
32 | 77 | ## Alternatives
|
33 | 78 |
|
34 |
| -* [jupyter/repo2docker](https://github.com/jupyter/repo2docker) - Turn git repositories into Jupyter-enabled Docker Images |
35 |
| -* [openshift/source-to-image](https://github.com/openshift/source-to-image) - A tool for building/building artifacts from source and injecting into docker images |
36 |
| -* [jupyter-on-openshift/jupyter-notebooks](https://github.com/jupyter-on-openshift/jupyter-notebooks) - OpenShift compatible S2I builder for basic notebook images |
| 79 | +- [jupyter/repo2docker](https://github.com/jupyter/repo2docker) - Turn git repositories into |
| 80 | + Jupyter-enabled Docker Images |
| 81 | +- [openshift/source-to-image](https://github.com/openshift/source-to-image) - A tool for |
| 82 | + building/building artifacts from source and injecting into docker images |
| 83 | +- [jupyter-on-openshift/jupyter-notebooks](https://github.com/jupyter-on-openshift/jupyter-notebooks) - |
| 84 | + OpenShift compatible S2I builder for basic notebook images |
37 | 85 |
|
38 | 86 | ## Resources
|
39 | 87 |
|
40 |
| -* [Documentation on ReadTheDocs](http://jupyter-docker-stacks.readthedocs.io/) |
41 |
| -* [Issue Tracker on GitHub](https://github.com/jupyter/docker-stacks) |
42 |
| -* [Jupyter Discourse Q&A](https://discourse.jupyter.org/c/questions) |
43 |
| -* [Jupyter Website](https://jupyter.org) |
44 |
| -* [Images on DockerHub](https://hub.docker.com/u/jupyter) |
| 88 | +- [Documentation on ReadTheDocs](http://jupyter-docker-stacks.readthedocs.io/) |
| 89 | +- [Issue Tracker on GitHub](https://github.com/jupyter/docker-stacks) |
| 90 | +- [Jupyter Discourse Q&A](https://discourse.jupyter.org/c/questions) |
| 91 | +- [Jupyter Website](https://jupyter.org) |
| 92 | +- [Images on DockerHub](https://hub.docker.com/u/jupyter) |
0 commit comments