From 03038daa18021d5618620329611c1aa96d630943 Mon Sep 17 00:00:00 2001 From: Francesc Torradeflot Date: Tue, 30 Apr 2024 13:02:32 +0200 Subject: [PATCH] Some minor changes for consistency of the documentation --- README.md | 10 +++++++--- docker/container/README.md | 11 +++++++++-- docker/test_env/docker-compose-extension.yml | 2 +- 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c2e3cf5..3f00a2e 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,10 @@ for the frontend extension. ## Requirements -* JupyterLab >= 3.0 -* Rucio Server >= 1.28 +* JupyterLab >= 3.0, < 4 +* Rucio >= 32 + +The rest of the requirements can be found in the [setup.py](setup.py) of the project. ## Install @@ -56,7 +58,9 @@ If you want to contribute or build the extension from source, see [CONTRIBUTING. ## Quick Setup using Docker -This repository comes with a Docker image of [jupyter/scipy-notebook](https://hub.docker.com/r/jupyter/scipy-notebook) installed with the extension. +This repository comes with a Docker image of +[jupyter/docker-stack-foundation](https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#jupyter-docker-stacks-foundation) +defined [here](docker/container/README.md), that can be used to run the extension. To run the image, use the following command. diff --git a/docker/container/README.md b/docker/container/README.md index bbc8a01..bed3ed6 100644 --- a/docker/container/README.md +++ b/docker/container/README.md @@ -24,11 +24,11 @@ for our `rucio-jupyterlab` image. docker build . -t jupyter/docker-stacks-foundation:python-3.9 -### Building the `rucio-jupyterlab` docker image +### Building the `rucio/jupyterlab` docker image From the root folder of the project, run - docker build . -t rucio-jupyterlab -f docker/container/Dockerfile + docker build . -t rucio/jupyterlab -f docker/container/Dockerfile ## Using the image @@ -37,6 +37,13 @@ From the root folder of the project, run Check the instructions in [the main README](../../README.md) to see how to use the image standalone, that is without the rest of the Rucio development environment +If the environment variables `X509_USER_KEY` and `X509_USER_CERT` are provided to the `docker run` + command, a X509 proxy will be initialized at container startup. + +An already initialized container can directly be used inside the container, mounting +it to the default X509 proxy location (e.g. /tmp/x509up_u1000) or mounting it into +a different location and pointing the `X509_USER_PROXY` environment variable to it. + ### Inside Rucio's development environment Check the instructions on [how to use the test environment](../test_env/README.md) to diff --git a/docker/test_env/docker-compose-extension.yml b/docker/test_env/docker-compose-extension.yml index 938762a..ffb2fde 100644 --- a/docker/test_env/docker-compose-extension.yml +++ b/docker/test_env/docker-compose-extension.yml @@ -10,7 +10,7 @@ services: depends_on: - ruciodb rucio-jupyterlab: - image: "rucio-jupyterlab" + image: "rucio/jupyterlab" build: context: . profiles: