hazza/docker-stacks
1
0
Fork 0
mirror of https://github.com/jupyter/docker-stacks.git synced 2025-10-18 15:32:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use correct ServerApp options in examples and tests (#1947)

Browse Source
This commit is contained in:
Ayaz Salikhov
2023-07-26 20:09:47 +04:00
committed by GitHub
parent 75ca54d550
commit bfe5f20914
10 changed files with 28 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/using/common.md
View File

@@ -11,19 +11,19 @@ This page describes the options supported by the startup script and how to bypas
You can pass [Jupyter server options](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html) to the `start-notebook.sh` script when launching the container. You can pass [Jupyter server options](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html) to the `start-notebook.sh` script when launching the container.
1. For example, to secure the Notebook server with a [custom password](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#preparing-a-hashed-password) 1. For example, to secure the Notebook server with a [custom password](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#preparing-a-hashed-password)
hashed using `jupyter_server.auth.security.passwd()` instead of the default token, hashed using `jupyter_server.auth.passwd()` instead of the default token,
you can run the following (this hash was generated for the `my-password` password): you can run the following (this hash was generated for the `my-password` password):
```bash ```bash
docker run -it --rm -p 8888:8888 jupyter/base-notebook \ docker run -it --rm -p 8888:8888 jupyter/base-notebook \
start-notebook.sh --NotebookApp.password='argon2:$argon2id$v=19$m=10240,t=10,p=8$JdAN3fe9J45NvK/EPuGCvA$O/tbxglbwRpOFuBNTYrymAEH6370Q2z+eS1eF4GM6Do' start-notebook.sh --PasswordIdentityProvider.hashed_password='argon2:$argon2id$v=19$m=10240,t=10,p=8$JdAN3fe9J45NvK/EPuGCvA$O/tbxglbwRpOFuBNTYrymAEH6370Q2z+eS1eF4GM6Do'
``` ```
2. To set the [base URL](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#running-the-notebook-with-a-customized-url-prefix) of the notebook server, you can run the following: 2. To set the [base URL](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#running-the-notebook-with-a-customized-url-prefix) of the notebook server, you can run the following:
```bash ```bash
docker run -it --rm -p 8888:8888 jupyter/base-notebook \ docker run -it --rm -p 8888:8888 jupyter/base-notebook \
start-notebook.sh --NotebookApp.base_url=/customized/url/prefix/ start-notebook.sh --ServerApp.base_url=/customized/url/prefix/
``` ```
## Docker Options ## Docker Options
@@ -148,8 +148,8 @@ docker run -it --rm -p 8888:8888 \
-v /some/host/folder:/etc/ssl/notebook \ -v /some/host/folder:/etc/ssl/notebook \
jupyter/base-notebook \ jupyter/base-notebook \
start-notebook.sh \ start-notebook.sh \
--NotebookApp.keyfile=/etc/ssl/notebook/notebook.key \ --ServerApp.keyfile=/etc/ssl/notebook/notebook.key \
--NotebookApp.certfile=/etc/ssl/notebook/notebook.crt --ServerApp.certfile=/etc/ssl/notebook/notebook.crt
``` ```
Alternatively, you may mount a single PEM file containing both the key and certificate. Alternatively, you may mount a single PEM file containing both the key and certificate.
@@ -160,7 +160,7 @@ docker run -it --rm -p 8888:8888 \
-v /some/host/folder/notebook.pem:/etc/ssl/notebook.pem \ -v /some/host/folder/notebook.pem:/etc/ssl/notebook.pem \
jupyter/base-notebook \ jupyter/base-notebook \
start-notebook.sh \ start-notebook.sh \
--NotebookApp.certfile=/etc/ssl/notebook.pem --ServerApp.certfile=/etc/ssl/notebook.pem
``` ```
In either case, Jupyter Notebook expects the key and certificate to be a **base64 encoded text file**. In either case, Jupyter Notebook expects the key and certificate to be a **base64 encoded text file**.

7
docs/using/recipes.md
View File

@@ -475,15 +475,16 @@ For JupyterLab:
```bash ```bash
docker run -it --rm \ docker run -it --rm \
jupyter/base-notebook:2023-07-25 \ jupyter/base-notebook:2023-07-25 \
start.sh jupyter lab --LabApp.token='' start-notebook.sh --IdentityProvider.token=''
``` ```
For jupyter classic: For Jupyter Notebook:
```bash ```bash
docker run -it --rm \ docker run -it --rm \
-e DOCKER_STACKS_JUPYTER_CMD=notebook \
jupyter/base-notebook:2023-07-25 \ jupyter/base-notebook:2023-07-25 \
start.sh jupyter notebook --NotebookApp.token='' start-notebook.sh --IdentityProvider.token=''
``` ```
## Enable nbclassic-extension spellchecker for markdown (or any other nbclassic-extension) ## Enable nbclassic-extension spellchecker for markdown (or any other nbclassic-extension)

4
examples/docker-compose/notebook/letsencrypt-notebook.yml
View File

@@ -19,8 +19,8 @@ services:
PASSWORD: ${PASSWORD} PASSWORD: ${PASSWORD}
command: > command: >
start-notebook.sh start-notebook.sh
--NotebookApp.certfile=/etc/letsencrypt/fullchain.pem --ServerApp.certfile=/etc/letsencrypt/fullchain.pem
--NotebookApp.keyfile=/etc/letsencrypt/privkey.pem --ServerApp.keyfile=/etc/letsencrypt/privkey.pem
volumes: volumes:
work: work:

4
examples/make-deploy/letsencrypt.makefile
View File

@@ -52,8 +52,8 @@ letsencrypt-notebook: DOCKER_ARGS:=-e USE_HTTPS=yes \
-e PASSWORD=$(PASSWORD) \ -e PASSWORD=$(PASSWORD) \
-v $(SECRETS_VOLUME):/etc/letsencrypt -v $(SECRETS_VOLUME):/etc/letsencrypt
letsencrypt-notebook: ARGS:=\ letsencrypt-notebook: ARGS:=\
--NotebookApp.certfile=/etc/letsencrypt/fullchain.pem \ --ServerApp.certfile=/etc/letsencrypt/fullchain.pem \
--NotebookApp.keyfile=/etc/letsencrypt/privkey.pem --ServerApp.keyfile=/etc/letsencrypt/privkey.pem
letsencrypt-notebook: check letsencrypt-notebook: check
@test -n "$(PASSWORD)" || \ @test -n "$(PASSWORD)" || \
(echo "ERROR: PASSWORD not defined or blank"; exit 1) (echo "ERROR: PASSWORD not defined or blank"; exit 1)

2
examples/openshift/templates.json
View File

@@ -38,7 +38,7 @@
} }
}, },
"data": { "data": {
"jupyter_server_config.py": "import os\n\npassword = os.environ.get('JUPYTER_NOTEBOOK_PASSWORD')\n\nif password:\n import notebook.auth\n c.NotebookApp.password = notebook.auth.passwd(password)\n del password\n del os.environ['JUPYTER_NOTEBOOK_PASSWORD']\n\nimage_config_file = '/home/jovyan/.jupyter/jupyter_server_config.py'\n\nif os.path.exists(image_config_file):\n with open(image_config_file) as fp:\n exec(compile(fp.read(), image_config_file, 'exec'), globals())\n" "jupyter_server_config.py": "import os\n\npassword = os.environ.get('JUPYTER_NOTEBOOK_PASSWORD')\n\nif password:\n from jupyter_server.auth import passwd\n c.ServerApp.password = passwd(password)\n del password\n del os.environ['JUPYTER_NOTEBOOK_PASSWORD']\n\nimage_config_file = '/home/jovyan/.jupyter/jupyter_server_config.py'\n\nif os.path.exists(image_config_file):\n with open(image_config_file) as fp:\n exec(compile(fp.read(), image_config_file, 'exec'), globals())\n"
} }
}, },
{ {

2
examples/source-to-image/templates.json
View File

@@ -221,7 +221,7 @@
} }
}, },
"data": { "data": {
"jupyter_server_config.py": "import os\n\npassword = os.environ.get('JUPYTER_NOTEBOOK_PASSWORD')\n\nif password:\n import notebook.auth\n c.NotebookApp.password = notebook.auth.passwd(password)\n del password\n del os.environ['JUPYTER_NOTEBOOK_PASSWORD']\n\nimage_config_file = '/home/jovyan/.jupyter/jupyter_server_config.py'\n\nif os.path.exists(image_config_file):\n with open(image_config_file) as fp:\n exec(compile(fp.read(), image_config_file, 'exec'), globals())\n" "jupyter_server_config.py": "import os\n\npassword = os.environ.get('JUPYTER_NOTEBOOK_PASSWORD')\n\nif password:\n from jupyter_server.auth import passwd\n c.ServerApp.password = passwd(password)\n del password\n del os.environ['JUPYTER_NOTEBOOK_PASSWORD']\n\nimage_config_file = '/home/jovyan/.jupyter/jupyter_server_config.py'\n\nif os.path.exists(image_config_file):\n with open(image_config_file) as fp:\n exec(compile(fp.read(), image_config_file, 'exec'), globals())\n"
} }
}, },
{ {

4
tests/base-notebook/test_container_options.py
View File

@@ -16,7 +16,7 @@ def test_cli_args(container: TrackedContainer, http_client: requests.Session) ->
(e.g., disabling token security)""" (e.g., disabling token security)"""
host_port = find_free_port() host_port = find_free_port()
running_container = container.run_detached( running_container = container.run_detached(
command=["start-notebook.sh", "--NotebookApp.token=''"], command=["start-notebook.sh", "--IdentityProvider.token=''"],
ports={"8888/tcp": host_port}, ports={"8888/tcp": host_port},
) )
resp = http_client.get(f"http://localhost:{host_port}") resp = http_client.get(f"http://localhost:{host_port}")
@@ -103,7 +103,7 @@ def test_custom_internal_port(
host_port = find_free_port() host_port = find_free_port()
internal_port = env.get("JUPYTER_PORT", 8888) internal_port = env.get("JUPYTER_PORT", 8888)
running_container = container.run_detached( running_container = container.run_detached(
command=["start-notebook.sh", "--NotebookApp.token=''"], command=["start-notebook.sh", "--IdentityProvider.token=''"],
environment=env, environment=env,
ports={internal_port: host_port}, ports={internal_port: host_port},
) )

16
tests/base-notebook/test_healthcheck.py
View File

@@ -22,23 +22,23 @@ LOGGER = logging.getLogger(__name__)
(["RESTARTABLE=yes"], None, None), (["RESTARTABLE=yes"], None, None),
(["JUPYTER_PORT=8171"], None, None), (["JUPYTER_PORT=8171"], None, None),
(["JUPYTER_PORT=8117", "DOCKER_STACKS_JUPYTER_CMD=notebook"], None, None), (["JUPYTER_PORT=8117", "DOCKER_STACKS_JUPYTER_CMD=notebook"], None, None),
(None, ["start-notebook.sh", "--NotebookApp.base_url=/test"], None), (None, ["start-notebook.sh", "--ServerApp.base_url=/test"], None),
(None, ["start-notebook.sh", "--NotebookApp.base_url=/test/"], None), (None, ["start-notebook.sh", "--ServerApp.base_url=/test/"], None),
(["GEN_CERT=1"], ["start-notebook.sh", "--NotebookApp.base_url=/test"], None), (["GEN_CERT=1"], ["start-notebook.sh", "--ServerApp.base_url=/test"], None),
( (
["GEN_CERT=1", "JUPYTER_PORT=7891"], ["GEN_CERT=1", "JUPYTER_PORT=7891"],
["start-notebook.sh", "--NotebookApp.base_url=/test"], ["start-notebook.sh", "--ServerApp.base_url=/test"],
None, None,
), ),
(["NB_USER=testuser", "CHOWN_HOME=1"], None, "root"), (["NB_USER=testuser", "CHOWN_HOME=1"], None, "root"),
( (
["NB_USER=testuser", "CHOWN_HOME=1"], ["NB_USER=testuser", "CHOWN_HOME=1"],
["start-notebook.sh", "--NotebookApp.base_url=/test"], ["start-notebook.sh", "--ServerApp.base_url=/test"],
"root", "root",
), ),
( (
["NB_USER=testuser", "CHOWN_HOME=1", "JUPYTER_PORT=8123"], ["NB_USER=testuser", "CHOWN_HOME=1", "JUPYTER_PORT=8123"],
["start-notebook.sh", "--NotebookApp.base_url=/test"], ["start-notebook.sh", "--ServerApp.base_url=/test"],
"root", "root",
), ),
], ],
@@ -75,12 +75,12 @@ def test_health(
(["NB_USER=testuser", "CHOWN_HOME=1"], None, None), (["NB_USER=testuser", "CHOWN_HOME=1"], None, None),
( (
["NB_USER=testuser", "CHOWN_HOME=1"], ["NB_USER=testuser", "CHOWN_HOME=1"],
["start-notebook.sh", "--NotebookApp.base_url=/test"], ["start-notebook.sh", "--ServerApp.base_url=/test"],
None, None,
), ),
( (
["NB_USER=testuser", "CHOWN_HOME=1", "JUPYTER_PORT=8123"], ["NB_USER=testuser", "CHOWN_HOME=1", "JUPYTER_PORT=8123"],
["start-notebook.sh", "--NotebookApp.base_url=/test"], ["start-notebook.sh", "--ServerApp.base_url=/test"],
None, None,
), ),
], ],

1
tests/base-notebook/test_start_container.py
View File

@@ -45,7 +45,6 @@ def test_start_notebook(
running_container = container.run_detached( running_container = container.run_detached(
tty=True, tty=True,
environment=env, environment=env,
command=["start-notebook.sh"],
ports={"8888/tcp": host_port}, ports={"8888/tcp": host_port},
) )
# sleeping some time to let the server start # sleeping some time to let the server start

7
tests/pluto_check.py
View File

@@ -18,11 +18,8 @@ def check_pluto_proxy(
token = secrets.token_hex() token = secrets.token_hex()
container.run_detached( container.run_detached(
command=[ command=[
"start.sh", "start-notebook.sh",
"jupyter", f"--IdentityProvider.token={token}",
"lab",
"--port=8888",
f"--LabApp.token={token}",
], ],
ports={"8888/tcp": host_port}, ports={"8888/tcp": host_port},
) )