X-Git-Url: https://gitweb.ps.run/ps-cgit/blobdiff_plain/ce1c7336e5b3e3ebe8f8c9029c405aedec98c208..47bae9f58d5ecae437767b8e7835b23ad1804d0b:/cgitrc

diff --git a/cgitrc b/cgitrc
index da3d138..796a62c 100644
--- a/cgitrc
+++ b/cgitrc
@@ -3,56 +3,130 @@
 ##
 
 
-## base for virtual urls. If specified, rewrite rules must be added to 
-## httpd.conf. Possible rules for /git/ when cgit.cgi is accessed as /cgit.cgi:
+## Uncomment and set to 1 to deactivate caching of generated pages. Mostly
+## usefull for testing.
+#nocache=0
+
+
+## Set allowed snapshot types by default. Can be overridden per repo
+# can be any combination of zip/tar.gz/tar.bz2/tar
+#snapshots=0
+
+
+## Enable/disable extra links to summary/log/tree per repo on index page
+#enable-index-links=0
+
+
+## Enable/disable display of 'number of files changed' in log view
+#enable-log-filecount=0
+
+
+## Enable/disable display of 'number of lines changed' in log view
+#enable-log-linecount=0
+
+
+## Enable/disable display of HEAD shortlog in summary view. Set it to maximum
+## number of commits that should be displayed
+#summary-log=0
+
+
+## The "Idle" column on the repository index page can read a timestamp
+## from the specified agefile (if this file cannot be found, the mtime
+## of HEAD is used).
+## The cgit repo on hjemli.net uses the the following command in it's
+## post-receive hook to update the age-file:
+##   git-for-each-ref --format="%(committerdate)" --sort=-committerdate \
+##     --count=1 > $GIT_DIR/info/web/last-modifie
 ##
-##   RewriteRule ^/git/$ /cgit.cgi                            [L,QSA]
-##   RewriteRule ^/git/([^/]+)/$ /cgit.cgi?r=$1               [L,QSA]
-##   RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit.cgi?r=$1&p=$2  [L,QSA]
+#agefile=info/web/last-modified
+
+
+## Git detects renames, but with a limit on the number of files to
+## consider. This option can be used to specify another limit (or -1 to
+## use the default limit).
 ##
+#renamelimit=-1
+
+
+## Specify a root for virtual urls. This makes cgit generate urls like
+##
+##    http://localhost/git/repo/log/?h=branch
+##
+## instead of
+##
+##    http://localhost/cgit/cgit.cgi?url=repo/log&h=branch
+##
+## For this to work with apache, a rewrite rule must be added to httpd.conf,
+## possibly looking something like this:
+##
+##    RewriteRule ^/git/(.*)$ /cgit/cgit.cgi?url=$1   [L,QSA]
+##
+## For this to work with lighttpd, the rewrite rule should look more like this:
+##
+##    url.rewrite = (
+##        "^/git/([^?/]+/[^?]*)?(?:\?(.*))?$" => "/cgit.cgi?url=$1&$2"
+##    )
+##
+## This setting is disabled by default.
 #virtual-root=/git
 
 
-## page title for the root page (repo listing)
+## Set the title printed on the root page
 #root-title=Git repository browser
 
 
-## link to css file
-#css=/cgit.css
+## If specified, the file at this path will be included as HTML in the index
+## of repositories
+#index-header=
 
 
-## link to logo file
-#logo=/git-logo.png
+## Link to css file
+#css=/cgit/cgit.css
 
 
-## url loaded when clicking the logo
+## Link to logo file
+#logo=/cgit/git-logo.png
+
+
+## Url loaded when clicking the logo
 #logo-link=http://www.kernel.org/pub/software/scm/git/docs/
 
 
-## set number of initial chars to show of commit subject message in log views
+## Url loaded when clicking a submodule link
+#module-link=./?repo=%s&page=commit&id=%s
+
+
+## Number of chars shown of repo description (in repolist view)
+#max-repodesc-length=60
+
+
+## Number of chars shown of commit subject message (in log view)
 #max-message-length=60
 
 
-## Set to 1 to deactivate caching of generated pages
-#nocache=0
+## Number of commits per page in log view
+#max-commit-count=50
 
 
-## root path for cached output
+## Root of cached output
 #cache-root=/var/cache/cgit
 
 
+## Include another config-file
+#include=/var/cgit/repolist
+
 ##
-## Time-To-Live settings: specify how long (in minutes) different pages should
-## be cached. Specify 0 for instant expiration and -1 for immortal pages
+## Time-To-Live settings: specifies how long (in minutes) different pages
+## should be cached (0 for instant expiration, -1 for immortal pages)
 ##
 
-## ttl for root page (repo listing)
+## ttl for root page
 #cache-root-ttl=5
 
 ## ttl for repo summary page
 #cache-repo-ttl=5
 
-## ttl for other dynamic pages 
+## ttl for other dynamic pages
 #cache-dynamic-ttl=5
 
 ## ttl for static pages (addressed by SHA-1)
@@ -60,9 +134,34 @@
 
 
 
-## Example repository entry
+## Example repository entry. Required values are repo.url and repo.path (each
+## repository section must start with repo.url).
 #repo.url=cgit
 #repo.name=cgit
 #repo.desc=the caching cgi for git
-#repo.path=/pub/git/cgit
+#repo.path=/pub/git/cgit			## this is the path to $GIT_DIR
 #repo.owner=Lars Hjemli
+#repo.defbranch=master				## define a default branch
+#repo.snapshots=tar.bz2				## override a sitewide snapshot-setting
+#repo.enable-log-filecount=0			## override the default filecount setting
+#repo.enable-log-linecount=0			## override the default linecount setting
+#repo.module-link=/git/%s/commit/?id=%s		## override the standard module-link
+#repo.readme=info/web/readme			## specify a file to include on summary page
+
+## Additional repositories grouped under "mirrors"
+#repo.group=mirrors
+
+#repo.url=git
+#repo.path=/pub/git/git
+#
+#repo.url=linux
+#repo.path=/pub/git/linux
+
+## A group of private repositories (with a working directory)
+#repo.group=private
+
+#repo.url=larsh/cgit
+#repo.path=/home/larsh/src/cgit/.git
+
+#repo.url=larsh/git
+#repo.path=/home/larsh/src/git/.git