1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8ca3065
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# My cgit docker container
+
+## Usage
+
+### Docker compose
+
+Bind mount your git repos to `/repos` and a data folder to `/root/.local/share/caddy`.
+The only environment variable is `SITE_ADDRESS`. If unset then localhost will be used (which you can't really use since the certs are inside the container).
+
+    services:
+      cgit:
+        build: ./cgit
+        ports:
+          - "443:443"
+          - "80:80"
+        volumes:
+          - ~/repos:/repos
+          - ./data:/root/.local/share/caddy
+        environment:
+          SITE_ADDRESS: git.soltermann.xyz