Skip to content

Commit

Permalink
Some minor changes for consistency of the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Francesc Torradeflot committed Apr 30, 2024
1 parent dc1395d commit 03038da
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down
11 changes: 9 additions & 2 deletions docker/container/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docker/test_env/docker-compose-extension.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ services:
depends_on:
- ruciodb
rucio-jupyterlab:
image: "rucio-jupyterlab"
image: "rucio/jupyterlab"
build:
context: .
profiles:
Expand Down

0 comments on commit 03038da

Please sign in to comment.