From 412c3660be0c85a256762465f476d19fff3633b1 Mon Sep 17 00:00:00 2001
From: Graskaas <graskaas-gaming@protonmail.com>
Date: Mon, 28 Aug 2023 21:51:46 +0200
Subject: [PATCH] Add docker-compose example

---
 README.md                           |  8 ++++++++
 docker-compose.override.yml.example |  4 ++++
 docker-compose.yml                  |  9 +++++++++
 3 files changed, 21 insertions(+)

diff --git a/README.md b/README.md
index 88dbb49..3a2e03c 100644
--- a/README.md
+++ a/README.md
@@ -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.
diff --git a/docker-compose.override.yml.example b/docker-compose.override.yml.example
new file mode 100644
index 0000000..8b3c820 100644
--- /dev/null
+++ a/docker-compose.override.yml.example
@@ -1,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 100644
--- /dev/null
+++ a/docker-compose.yml
@@ -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
--
rgit 0.1.3