From 168135966952b03d50bef07058ff790011d177b2 Mon Sep 17 00:00:00 2001 From: Bryce Kwon Date: Fri, 6 Nov 2026 22:43:42 -1000 Subject: Describe the drop-in server configs in README --- README.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.txt b/README.txt index a01db27..9be2cf7 100644 --- a/README.txt +++ b/README.txt @@ -10,7 +10,7 @@ Source tree * source/ is the C code, built inside the Git tree in vendor/git, and assets/ holds the static files make install copies. -* custom/ holds the reference cgitrc, the web server configs in servers/, the +* custom/ holds the reference cgitrc, drop-in server configs in servers/, the Lua filters in extensions/ and in hooks/ standalone post-receive hooks that keep the idle column, the cache and the commit-graph current. * tools/ holds build-release.sh for a hardened build, without Lua unless given @@ -104,9 +104,11 @@ repo.url and a repo.path line for each. They have to be readable by the account the web server runs cgit as, www-data on Debian, since a scanned repository it cannot read is left off the index with only a line in the error log. -Complete, commented configurations for nginx, Apache and lighttpd live in -custom/servers/, each explaining how that server routes requests to the binary -and serves the static assets off disk. Install the one for your server. +custom/servers/ holds a short config for each of nginx, Apache and lighttpd +that serves cgit over plain HTTP at the root of git.example.org, with HTTPS +and git-http-backend for smart HTTP clone and push as commented examples. +Their headers say what each needs and which paths it assumes. Change the host +name and include the one for your server from its main config. The cache is off until cache-size is set above 0, as in cache-size=1000 placed above scan-path. Its directory has to exist first, owned by the same account @@ -202,7 +204,8 @@ A theme that only wants a colour change is a few lines. Keep a theme in a file of its own, since make install overwrites cgit.css. The first css line replaces the default rather than adding to it, as a js line does cgit.js, so list cgit.css first. The server configs in custom/servers/ serve -only the shipped files off disk, so add the theme to them too. +only the five shipped files from /usr/share/cgit and send every other url to +cgit, so put the theme there and add its name to their list. css=/cgit.css css=/theme.css -- cgit 2.12.1