Skip to content

Commit 13408a0

Browse files
asmacdokabilaryarikoptic
authored
Apply suggestions from code review
Co-authored-by: Kabilar Gunalan <[email protected]> Co-authored-by: Yaroslav Halchenko <[email protected]>
1 parent 0173f7f commit 13408a0

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

docs/50_hub.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,18 @@ A "Base (MATLAB)" server is also available, which provides a MATLAB cloud instal
2121

2222
## Custom server image
2323

24-
If you need additional software installed in the image, you can add a server image that will be made available for all users in the `Server Options` menu. Add a server image by updating the `profileList` in the [JupyterHub config file](https://github.com/dandi/dandi-hub/blob/do-eks/helm/jupyterhub/dandihub.yaml) and submitting a pull request to the [dandi-hub repository](https://github.com/dandi/dandi-hub). Once the pull request is merged, the DANDI team will redeploy JupyterHub and the image will be available.
24+
If you need additional software installed in the image, you can add a server image that will be made available for all users in the `Server Options` menu. Add a server image by following the instructions below and submitting a pull request to the [dandi-hub repository](https://github.com/dandi/dandi-hub). Once the pull request is merged, the DANDI team will redeploy JupyterHub and the image will be available.
2525

26-
See https://github.com/dandi/dandi-hub/pull/233 as an example of the changes you need.
27-
28-
29-
The following command will build and run a new image, which can be viewed locally in the browser at 127.0.0.1:8888/
3026

27+
1. Fork and clone the [dandi-hub](https://github.com/dandi/dandi-hub) repository.
28+
2. Add a Dockerfile to the [images](https://github.com/dandi/dandi-hub/tree/main/images) directory.
29+
3. Test the Dockerfile with the following commands to build and run the new image, which can be viewed locally in the browser at 127.0.0.1:8888/
3130
```sh
32-
docker build -f $(CONTAINERFILE) -t dandihub-dev:latest .
31+
docker build -f "$(CONTAINERFILE)" -t dandihub-dev:latest .
3332
docker run --rm -p 8888:8888 --name dev_jupyterlab dandihub-dev:latest start-notebook.sh --NotebookApp.token=""
3433
```
35-
36-
To add the new image to the test CI, and to the Dandi Archive Dockerhub, add it to the `include`
37-
matrix of both `.github/workflows/docker-push.yaml` and `.github/workflows/docker-test.yaml`.
38-
39-
You can add the image to server options by adding options to `envs/shared/jupyterhub.yaml`
40-
34+
4. Add the Dockerfile to the `include` matrix of both the [docker-push.yaml](https://github.com/dandi/dandi-hub/blob/main/.github/workflows/docker-push.yaml) and [docker-test.yaml](https://github.com/dandi/dandi-hub/blob/main/.github/workflows/docker-test.yaml) files. This will allow the image to be built when new pull requests are opened and pushed to the [DANDI Archive Docker Hub](https://hub.docker.com/u/dandiarchive) when the pull requests are merged.
35+
5. Add the image to the server options by updating the [jupyterhub.yaml](https://github.com/dandi/dandi-hub/blob/main/envs/shared/jupyterhub.yaml) file.
4136

4237
## Example notebooks
4338

0 commit comments

Comments
 (0)