Add docker-compose example
Diff
README.md | 8 ++++++++
docker-compose.override.yml.example | 4 ++++
docker-compose.yml | 9 +++++++++
3 files changed, 21 insertions(+)
@@ -117,3 +117,11 @@
docker run --mount type=bind,source=/path/to/my-repos,target=/git \
-it ghcr.io/w4/rgit:main
```
#### Docker Compose
An example `docker-compose.yml` is provided for those who prefer using Compose. To configure the UID and GID, the user is specified in `docker-compose.override.yml`.
An example override file has been has been provided with the repository. To use it, remove the `.example` extension from `docker-compose.override.yml.example`, and adjust the UID and GID to match the user that owns the directory containing your repositories.
Afterwards, bring up the container with `docker-compose up` to make sure everything works.
@@ -1,0 +1,4 @@
version: '3'
services:
rgit:
user: 1000:1000
@@ -1,0 +1,9 @@
version: '3'
services:
rgit:
image: ghcr.io/w4/rgit:main
volumes:
- /path/to/my-repos:/git
ports:
- 3333:8000
restart: unless-stopped