gitscope
← rgit / Diff · 412c366 → 412c366
Changes 412c366..412c366
Patch commit
diff --git a/README.md b/README.md
index 88dbb49..3a2e03c 100644
--- a/README.md
+++ b/README.md
@@ -117,3 +117,11 @@ Running rgit in Docker is also simple, just mount the directory containing your
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.
diff --git a/docker-compose.override.yml.example b/docker-compose.override.yml.example
new file mode 100644
index 0000000..8b3c820
--- /dev/null
+++ b/docker-compose.override.yml.example
@@ -0,0 +1,4 @@
+version: '3'
+services:
+ rgit:
+ user: 1000:1000
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..dbb0670
--- /dev/null
+++ b/docker-compose.yml
@@ -0,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