Skip to content

Commit

Permalink
Merge pull request #1380 from mathbunnyru/asalikhov/match_readme_and_…
Browse files Browse the repository at this point in the history
…index

Make README.md match index.rst
  • Loading branch information
mathbunnyru committed Jun 21, 2021
2 parents ebc453b + a0f0150 commit d378443
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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)
by simply clicking the preceding link.
The image used in binder was last updated on 22 May 2021.
Otherwise, the two 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
and want to launch a single Jupyter Notebook server in a container.

Expand Down
18 changes: 12 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,35 @@ You can use a stack image to do any of the following (and more):
Quick Start
-----------

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, three examples below may help you get started if you `have Docker installed <https://docs.docker.com/install/>`_, know :doc:`which Docker image <using/selecting>` you want to use, and want to launch a single Jupyter Notebook server in a container.
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.
Otherwise, three examples below may help you get started if you `have Docker installed <https://docs.docker.com/install/>`_,
know :doc:`which Docker image <using/selecting>` you want to use
and want to launch a single Jupyter Notebook server in a container.

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.
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.
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.::

docker run -p 8888:8888 jupyter/scipy-notebook:33add21fab64

**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 Jupyter Notebook server, where ``hostname`` is the name of the computer running docker and ``token`` is the secret token printed in the console.::
Visiting ``http://<hostname>:10000/?token=<token>`` in a browser loads Jupyter Notebook server,
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

**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.
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/lab?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.
Visiting ``http://<hostname>:10000/lab?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.::

docker run --rm -p 10000:8888 -e JUPYTER_ENABLE_LAB=yes -v "${PWD}":/home/jovyan/work jupyter/datascience-notebook:33add21fab64
Expand Down Expand Up @@ -74,6 +80,6 @@ Table of Contents
:maxdepth: 2
:caption: Getting Help

Issue Tracker on Github <https://github.com/jupyter/docker-stacks/issues>
Jupyter Discourse Forum <https://discourse.jupyter.org>
Stacks Issue Tracker <https://github.com/jupyter/docker-stacks/issues>
Jupyter Website <https://jupyter.org>

0 comments on commit d378443

Please sign in to comment.