Skip to content

Commit

Permalink
update readme and trigger a build
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneknapp committed Sep 5, 2024
1 parent 4c9e5df commit 2ffc048
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,24 @@
This is the repository for the data101 datahub and local user images.

See this repository's [CONTRIBUTING.md](https://github.com/berkeley-dsep-infra/data101-user-image/blob/main/CONTRIBUTING.md) for instructions. That information will eventually be migrated to docs.datahub.berkeley.edu.

# building the image locally

You can use [repo2-docker](https://repo2docker.readthedocs.io/en/latest/) to build and use/test the image on your own device.

launch `repo2docker` from inside the cloned image repo. To run on a linux/WSL2 linux shell:
```
repo2docker . # <--- the path to the repo
```

If you are using an ARM CPU (Apple M* silicon), you will need to run `jupyter-repo2docker` with the following arguments:

```
jupyter-repo2docker --user-id=1000 --user-name=jovyan \
--Repo2Docker.platform=linux/amd64 \
--target-repo-dir=/home/jovyan/.cache \
-e PLAYWRIGHT_BROWSERS_PATH=/srv/conda \
. # <--- the path to the repo
```

If you just want to see if the image builds, but not automatically launch a notebook, then add `--no-run` to the arguments (before the final `.`).

0 comments on commit 2ffc048

Please sign in to comment.