Merge pull request #5 from ASFOpenSARlab/test

docs: update README
ASFOpenSARlab · Jan 7, 2025 · 9ca0f04 · 9ca0f04
2 parents 617ac13 + d9975e2
commit 9ca0f04
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 52 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# deployment-opensarlab-container
+
+This repository hosts the container image used by OpenSARLab,
+(as well as several others) an
+[OpenScienceLab](https://asf.alaska.edu/asf-services-open-science-lab/)
+JupyterHub deployment.
+
+This image is also runnable locally: all packages are publicly available
+[here](https://github.com/orgs/ASFOpenSARlab/packages/container/package/deployment-opensarlab-container_sar).
+To run the image used in the production OpenSARLab environment, run
+the following from the command line:
+
+```bash
+docker run -p 8888:8888 ghcr.io/asfopensarlab/deployment-opensarlab-container_sar:main
+```
+
+Click the `127.0.0.1:8888` link that appears, and you will be able to access the image.