Skip to content

Commit c01e2a2

Browse files
committed
docs(readme): correct instructions for pulling from GHCR
1 parent b8a5e9d commit c01e2a2

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,22 +81,40 @@ You can find the version of python used for the models and app in the `binder/en
8181

8282
Alternatively, a docker environment has been provided.
8383

84+
#### Build docker image locally
85+
8486
You can build the image by running:
8587

8688
```
8789
docker build -f binder/Dockerfile -t gen_simpy_apps .
8890
```
8991

90-
Another option is to pull the image from the GitHub Container Registry:
92+
And run the container:
93+
94+
```
95+
docker run -p 8501:8501 gen_simpy_apps
96+
```
97+
98+
Open your browser to <http://localhost:8501/> to view the app.
99+
100+
#### Pull docker image from container registry
101+
102+
Another option is to pull the image from the GitHub Container Registry (GHCR). As explained in the [GHCR documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry), you'll need to create an access token to install from GHCR (even when it is a public image). You can create a token by going to your profile Settings > Developer Settings > Personal access tokens > Tokens (classic) > Generate new token. You can then login:
103+
104+
```
105+
docker login ghcr.io -u username -p accesstoken
106+
```
107+
108+
And should be able to pull the image:
91109

92110
```
93111
docker pull ghcr.io/pythonhealthdatascience/llm_simpy_models:latest
94112
```
95113

96-
Once you have the build image, you can then run the container:
114+
You can then run the container:
97115

98116
```
99-
docker run -p 8501:8501 gen_simpy_apps
117+
docker run -p 8501:8501 ghcr.io/pythonhealthdatascience/llm_simpy_models
100118
```
101119

102120
Open your browser to <http://localhost:8501/> to view the app.

0 commit comments

Comments
 (0)