Added GHCR to README (#115)

This commit is contained in:
Kieran 2024-03-24 15:40:16 -07:00 committed by GitHub
parent 937a14985f
commit 37c1da8014
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -81,8 +81,9 @@ services:
1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container. 1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container.
2. Prepare the docker image in one of the two ways below: 2. Prepare the docker image in one of the two ways below:
- **From Docker Hub:** `docker pull keglin/pinchflat:latest`, or; - **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest`
- **Building locally:** `docker build . --file selfhosted.Dockerfile -t keglin/pinchflat:latest` - NOTE: also available on Docker Hub at `keglin/pinchflat:latest`
- **Building locally:** `docker build . --file selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest`
3. Run the container: 3. Run the container:
```bash ```bash
@ -92,7 +93,7 @@ docker run \
-p 8945:8945 \ -p 8945:8945 \
-v /host/path/to/config:/config \ -v /host/path/to/config:/config \
-v /host/path/to/downloads:/downloads \ -v /host/path/to/downloads:/downloads \
keglin/pinchflat:latest ghcr.io/kieraneglin/pinchflat:latest
``` ```
### IMPORTANT: File permissions ### IMPORTANT: File permissions