From 352247449fa6fa4072953d7025717b0b269fe103 Mon Sep 17 00:00:00 2001 From: Egor Tensin Date: Tue, 29 Mar 2022 23:45:12 +0300 Subject: README: update --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 571b9cb..e6cfa56 100644 --- a/README.md +++ b/README.md @@ -61,11 +61,23 @@ There's a web server image with a working cgit installation: | Path | Description | ------------ | ----------- +| /etc/cgitrc | If you use a custom cgit configuration, map it here \[1\]. | /mnt/cgitize | Map cgitize's output directory here. +1. A custom cgitrc might look like this: + + # Include most common useful settings. + include=/etc/cgit/common + + # If you serve from a subdirectory. + virtual-root=/secret/ + + root-title=Custom title + root-desc=Custom description + #### Compose -See the root docker-compose.yml file for a possible service definition. +See the root docker-compose.yml file for a possible services definition. In this configuration, cgitize pulls my repositories from GitHub every 3 hours. You can test it by running -- cgit v1.2.3