m-chrzan.xyz
aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcin Chrzanowski <m@m-chrzan.xyz>2021-02-16 23:35:26 -0500
committerMarcin Chrzanowski <m@m-chrzan.xyz>2021-02-16 23:35:26 -0500
commit11f5bf5021cf78520643bf4e6ecc7de5a4d64e30 (patch)
tree20f71f78ba9482007119ce3d655e6deb1eb9a4d5
parentc4f0566b08e12cee6e9befb1ab2fbf99903e58fe (diff)
Add cgit config explanation
-rw-r--r--cgit.md83
1 files changed, 83 insertions, 0 deletions
diff --git a/cgit.md b/cgit.md
new file mode 100644
index 0000000..19443dc
--- /dev/null
+++ b/cgit.md
@@ -0,0 +1,83 @@
+# cgit, the hyperfast git web frontend
+
+## Serving with nginx
+
+ apt install cgit fcgiwrap
+
+Start and enable `fcgiwrap.socket`
+
+Nginx site configuration:
+
+ server {
+ server_name git.m-chrzan.xyz;
+ root /usr/share/cgit;
+ try_files $uri @cgit;
+
+ location @cgit {
+ include fastcgi_params;
+ fastcgi_param SCRIPT_FILENAME /usr/lib/cgit/cgit.cgi;
+ fastcgi_param PATH_INFO $uri;
+ fastcgi_param QUERY_STRING $args;
+ fastcgi_param HTTP_HOST $server_name;
+ fastcgi_pass unix:/run/fcgiwrap.socket;
+ }
+ }
+
+## Configuring cgit
+
+In `/etc/cgitrc`. See `man cgitrc` for more.
+
+Tell cgit where to look for repos:
+
+ scan-path=/srv/git
+
+Don't serve a logo image:
+ logo=
+
+Syntax highlighting (needs python3-pygments installed):
+
+ source-filter=/usr/lib/cgit/filters/syntax-highlighting.py
+
+Clone URLs (visible on the bottom of summary tab):
+
+ enable-http-clone=1
+ clone-url=https://<cgit domain>/$CGIT_REPO_URL
+
+Basic config:
+
+ root-title=<title>
+ root-desc=<description for home page>
+ enable-index-owner=0 # since it's only my code, no use to clutter with owner
+ repository-sort=age # sort by most recent commit (default is alphabetical)
+
+### Repo specific config
+
+First, set
+
+ enable-git-config=1
+
+Now settings under
+
+ [cgit]
+ whatever = ...
+
+will be used for `repo.whatever` settings in cgit.
+
+## READMEs
+
+Can specify a file to use under `/about`. Either directly in the repo's
+directory, or `<branch>:<path>` to take a file from the index at a particular
+commit.
+
+ readme=:README.md
+
+will use `README.md` from default branch.
+
+To render markdown as HTML (needs python3-markdown installed):
+
+ about-filter=/usr/lib/cgit/filters/html-converters/md2html
+
+To override rendering method:
+
+ repo.readme=:README.txt
+ about-filter=/usr/lib/cgit/filters/html-converters/txt2html