diff options
| author | Lambda <lambda@disroot.org> | 2025-12-10 18:43:52 -0500 |
|---|---|---|
| committer | Lambda <lambda@disroot.org> | 2025-12-10 18:43:52 -0500 |
| commit | 0c7bf0252aa5b9a2c3a3d95ce84370a3d67cb62b (patch) | |
| tree | 08b9ff10c19e0c05e10ec7b819eacaa6da1655b9 /README.md | |
| parent | 0c79ff01fe7eb5abf369e4c14edf8eeadb692c3b (diff) | |
| download | cgit-docker-0c7bf0252aa5b9a2c3a3d95ce84370a3d67cb62b.tar.gz cgit-docker-0c7bf0252aa5b9a2c3a3d95ce84370a3d67cb62b.tar.bz2 cgit-docker-0c7bf0252aa5b9a2c3a3d95ce84370a3d67cb62b.zip | |
Added README and compose example.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 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 +``` |