aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2022-03-29 23:45:12 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2022-03-29 23:45:12 +0300
commit352247449fa6fa4072953d7025717b0b269fe103 (patch)
tree66999254396aca3faca7a14145aa6563cca81847
parentfrontend: move cgitrc to /etc (diff)
downloadcgitize-352247449fa6fa4072953d7025717b0b269fe103.tar.gz
cgitize-352247449fa6fa4072953d7025717b0b269fe103.zip
README: update
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
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