summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md25
-rw-r--r--compose.yml17
-rw-r--r--etc/httpd/conf/httpd.conf (renamed from etc/httpd/httpd.conf)0
3 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..36c70f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# cgit-docker
+
+### About
+cgit is a CGI web interface for git scm developed by the guy who created wireguard. You can read more on the cgit project [here](https://git.zx2c4.com/cgit/about).
+
+There's no official docker container for cgit. However, this will you to easily deploy it.
+
+### Installation
+You can use Docker Compose to create an instance of the server.
+
+```yaml
+name: 'cgit-docker'
+
+services:
+ cgit:
+ container_name: cgit-docker
+ image: ratdad/cgit-docker:latest
+ ports:
+ - 80:80
+ volumes:
+ - ./etc/httpd/conf/httpd.conf:/etc/httpd/conf/httpd.conf # apply custom httpd config
+ - ./etc/cgitrc:/etc/cgitrc # apply custom cgit runtime config
+ - ./opt/highlight.sh:/opt/highlight.sh # use a custom highlight script
+ - ./srv/git/:/srv/git # mount the dir cgit reads for repositories
+```
diff --git a/compose.yml b/compose.yml
new file mode 100644
index 0000000..aca365f
--- /dev/null
+++ b/compose.yml
@@ -0,0 +1,17 @@
+#
+#
+# cgit-docker compose example
+
+name: 'cgit-docker'
+
+services:
+ cgit:
+ container_name: cgit-docker
+ image: ratdad/cgit-docker:latest
+ ports:
+ - 80:80
+ volumes:
+ - ./etc/httpd/conf/httpd.conf:/etc/httpd/conf/httpd.conf # apply custom httpd config
+ - ./etc/cgitrc:/etc/cgitrc # apply custom cgit runtime config
+ - ./opt/highlight.sh:/opt/highlight.sh # use a custom highlight script
+ - ./srv/git/:/srv/git # mount the dir cgit reads for repositories
diff --git a/etc/httpd/httpd.conf b/etc/httpd/conf/httpd.conf
index d99bd92..d99bd92 100644
--- a/etc/httpd/httpd.conf
+++ b/etc/httpd/conf/httpd.conf