diff options
context:
space:
mode:
Diffstat (limited to 'custom/cgitrc')
-rw-r--r--custom/cgitrc102
1 file changed, 28 insertions, 74 deletions
diff --git a/custom/cgitrc b/custom/cgitrc
index c522b90..8cb1831 100644
--- a/custom/cgitrc
+++ b/custom/cgitrc
@@ -10,17 +10,13 @@
# list repositories by hand in the per-repository section at the end of this
# file.
#
-# About pages (markdown, man and plain-text readmes) render through the bundled
-# about-render.lua about-filter, see the filter section below. Source syntax
+# About pages (markdown, man and plain-text readmes) can render through the
+# bundled about-render.lua about-filter in the filter section below. Source
+# syntax
# highlighting is optional and ships as a source-filter there too.
#
# One key=value pair per line. Lines starting with # are comments.
-
-##
-## Cache
-##
-
# Maximum number of entries in the cgit output cache. A value of 0 disables
# caching. Value is an integer. Default is 0.
cache-size=0
@@ -44,7 +40,7 @@ cache-summary-ttl=5
cache-scan-ttl=15
# Minutes to cache repo pages requested with a fixed SHA1. A negative value
-# never expires. Value is an integer number of minutes. Default is -1.
+# keeps the page forever. Value is an integer number of minutes. Default is -1.
cache-static-ttl=-1
# Minutes to cache repo pages requested without a fixed SHA1. Value is an
@@ -63,11 +59,6 @@ cache-snapshot-ttl=5
# requested. Values are 0 or 1. Default is 0.
enable-cache-list=0
-
-##
-## Site appearance
-##
-
# Heading text on the repository index page. Value is any text. Default is Git
# repository browser.
#root-title=Git repository browser
@@ -84,8 +75,8 @@ enable-cache-list=0
# is one or more [ref]path entries. Default is none.
#readme=:README.md
-# CSS document urls added to the head of every page. Value is one or more urls.
-# Default is /cgit.css.
+# CSS document urls added to the head of every page. An empty value disables
+# it. Value is one or more urls. Default is /cgit.css.
#css=/cgit.css
# JavaScript document urls included on every page. An empty value disables it.
@@ -133,11 +124,6 @@ embedded=0
# format string taking path and sha1. Default is none.
#module-link=/%s/commit/?id=%s
-
-##
-## Repository discovery
-##
-
# Directory scanned for git repositories at parse time. Value is a filesystem
# path that may use macros. Default is none.
#scan-path=/var/lib/git
@@ -184,11 +170,6 @@ enable-git-config=0
# filesystem path that may use macros. Default is none.
#include=/etc/cgitrc.d/extra
-
-##
-## Features
-##
-
# Provide a blame page for files and links to it. Values are 0 or 1. Default is
# 0.
enable-blame=0
@@ -251,13 +232,9 @@ enable-tree-group-dirs=0
# year. Default is unset.
#max-stats=year
-
-##
-## Snapshots and cloning
-##
-
-# Default set of snapshot archive formats to offer. Value is a space list of tar
-# tar.gz tar.bz2 tar.lz tar.xz tar.zst zip, or the word all. Default is none.
+# Default set of snapshot archive formats to offer. Value is a space-separated
+# list of tar tar.gz tar.bz2 tar.lz tar.xz tar.zst zip, or the word all. Default
+# is none.
#snapshots=tar.gz tar.xz zip
# Act as a dumb HTTP endpoint for git clones. Values are 0 or 1. Default is 1.
@@ -272,15 +249,10 @@ enable-http-clone=1
# space-separated url templates that may use macros. Default is none.
#clone-url=https://example.com/$CGIT_REPO_URL git://example.com/$CGIT_REPO_URL
-
-##
-## Filters
-##
-#
# A filter is an external command cgit runs to transform a piece of content.
# Prefix the command with lua: to run it through the built-in Lua interpreter,
# which avoids a fork per call, or with exec: to run a normal program. The
-# commands below that point at /usr/share/cgit/extensions/ use scripts this
+# commands below that point at /usr/local/lib/cgit/filters/ use scripts this
# repository ships under custom/extensions/. The ones written as
# /path/to/your-command mark where your own command goes.
@@ -291,36 +263,29 @@ enable-filter-overrides=0
# Filter command used to format about-page content. The bundled about-render.lua
# renders markdown, man pages and plain text. Value is a command optionally
# prefixed with exec or lua. Default is none.
-#about-filter=lua:/usr/share/cgit/extensions/about-render.lua
+#about-filter=lua:/usr/local/lib/cgit/filters/about-render.lua
# Filter command used to format commit messages, for example to turn object
# names and issue numbers into links. Value is a command optionally prefixed
# with exec or lua. Default is none.
-#commit-filter=lua:/usr/share/cgit/extensions/link-commits.lua
+#commit-filter=lua:/usr/local/lib/cgit/filters/link-commits.lua
# Filter command used to format author and committer emails, for example to add
# avatar images. Value is a command optionally prefixed with exec or lua.
# Default is none.
-#email-filter=lua:/usr/share/cgit/extensions/email-gravatar.lua
+#email-filter=lua:/usr/local/lib/cgit/filters/email-gravatar.lua
-# Filter command used to format plaintext blobs in the tree view. Without it
-# cgit serves the text plain. For syntax highlighting, the shipped filter below
-# uses the Scintillua lexers and needs the lpeg module installed too, on Debian
-# that is "apt install lua-lpeg". Missing either dependency means plain
-# uncolored text, not an error. See the comments in that file. Value is a
-# command optionally prefixed with exec or lua. Default is none.
-#source-filter=lua:/usr/share/cgit/extensions/syntax-highlight.lua
+# Filter command used to format plaintext blobs in the tree view. The shipped
+# filter uses the Scintillua lexers and needs lpeg, and missing either means
+# plain uncolored text, not an error.
+# Value is a command optionally prefixed with exec or lua. Default is none.
+#source-filter=lua:/usr/local/lib/cgit/filters/syntax-highlight.lua
# Filter command invoked to authenticate access, gating repositories behind a
# login. See custom/extensions/auth-inline.lua and
# custom/extensions/auth-file.lua. Value is a command optionally prefixed with
# exec or lua. Default is none.
-#auth-filter=lua:/usr/share/cgit/extensions/auth-inline.lua
-
-
-##
-## Limits and safety
-##
+#auth-filter=lua:/usr/local/lib/cgit/filters/auth-inline.lua
# Number of items to display in atom feeds. Value is an integer. Default is 10.
max-atom-items=10
@@ -337,7 +302,7 @@ max-repodesc-length=80
# value of 0 disables the limit. Value is an integer. Default is 10240.
max-blob-size=10240
-# Number of repos listed per page on the index. A value of 0 or negative shows
+# Number of repos listed per page on the index. Zero or a negative value shows
# all repos. Value is an integer. Default is 50.
max-repo-count=50
@@ -369,11 +334,6 @@ max-ref-count=200
# compile-time value. Value is an integer. Default is -1.
rename-limit=-1
-
-##
-## Presentation
-##
-
# Number of log entries shown in the summary view. Value is an integer. Default
# is 10.
summary-log=10
@@ -408,8 +368,8 @@ branch-sort=name
# Sort items in the repo list case-sensitively. Values are 0 or 1. Default is 1.
case-sensitive-sort=1
-# Show full author email addresses beside names. Set to 0 to hide them. Values
-# are 0 or 1. Default is 1.
+# Show full author email addresses beside names. Values are 0 or 1. Default is
+# 1.
enable-plain-email=1
# File giving the timestamp of the youngest commit. Value is a path relative to
@@ -429,16 +389,10 @@ enable-plain-email=1
#mimetype.png=image/png
#mimetype.svg=image/svg+xml
-
-##
-## Per-repository overrides
-##
-#
-# Each repository is introduced by a repo.url line, which must be the first
-# setting of the block. All following repo.* settings apply to that repo until
-# the next repo.url line. When repos are discovered via scan-path the repo.
-# prefix is dropped inside each repo cgitrc and repo.url and repo.path are not
-# allowed there.
+# Each repository is introduced by a repo.url line. All following repo.*
+# settings apply to that repo until the next repo.url line. When repos are
+# discovered via scan-path the repo. prefix is dropped inside each repo cgitrc
+# and repo.url and repo.path are not allowed there.
# Relative url for a repo. Must be the first setting of each repo block. Value
# is a relative url path. Default is none.
@@ -566,7 +520,7 @@ enable-plain-email=1
# Per-repo override of the commit-filter. Only honoured when
# enable-filter-overrides is 1. Value is a command. Default is the global
# commit-filter value.
-#repo.commit-filter=lua:/usr/share/cgit/extensions/link-commits.lua
+#repo.commit-filter=lua:/usr/local/lib/cgit/filters/link-commits.lua
# Per-repo override of the source-filter. Only honoured when
# enable-filter-overrides is 1. Value is a command. Default is the global
@@ -576,4 +530,4 @@ enable-plain-email=1
# Per-repo override of the email-filter. Only honoured when
# enable-filter-overrides is 1. Value is a command. Default is the global
# email-filter value.
-#repo.email-filter=lua:/usr/share/cgit/extensions/email-gravatar.lua
+#repo.email-filter=lua:/usr/local/lib/cgit/filters/email-gravatar.lua