diff --git a/README.md b/README.md index 2c31e8e90b2ba857cd8eaddd4078f7d1e53d1151..58176a501008da8816a3a962cba51d9ea2ab7054 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,21 @@ TBD ### Docker -For advanced users only: If you happen to have Docker installed, you can start a local dockerized JupyterLab with +If you happen to have Docker installed, you can start a local dockerized JupyterLab for testing your profile: ```bash -docker run --name='jupyter-example-profile' --rm -it -p 8888:8888 registry.git-ce.rwth-aachen.de/jupyter/profiles/example:master +# Navigate to your local clone of this repo +cd path/to/example-profile + +# Login to the RWTH GitLab Docker registry +# (required for pulling the base image) +docker login registry.git.rwth-aachen.de + +# Build the Docker image +docker build --tag jupyter-example-profile . + +# Run the Docker image +docker run --name='jupyter-example-profile' --rm --interactive --tty --publish 8888:8888 --volume ${HOME}:/home/jovyan jupyter-example-profile ``` Copy and paste the displayed link to your favorite browser.