aboutsummaryrefslogtreecommitdiff
path: root/cgitrc
diff options
context:
space:
mode:
authorLars Hjemli <hjemli@gmail.com>2007-02-04 23:24:08 +0100
committerLars Hjemli <hjemli@gmail.com>2007-02-04 23:24:08 +0100
commit74b0db95560e4c11439d7e0e8016d1e8cd48cdda (patch)
tree3bc0b9c2a5fb171562e72cb79945b7527670f651 /cgitrc
parent8fb2f056961e577a039ae185d89ab8e2d2840b9e (diff)
downloadcgit-74b0db95560e4c11439d7e0e8016d1e8cd48cdda.tar.gz
cgit-74b0db95560e4c11439d7e0e8016d1e8cd48cdda.tar.bz2
Update cgitrc template
Make the descriptions more helpfull. Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (limited to 'cgitrc')
-rw-r--r--cgitrc53
1 files changed, 32 insertions, 21 deletions
diff --git a/cgitrc b/cgitrc
index da3d138..d45f9c2 100644
--- a/cgitrc
+++ b/cgitrc
@@ -3,50 +3,60 @@
##
-## 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
+
+
+## Specify a root for virtual urls. This makes cgit generate urls like
+##
+## http://localhost/git/repo/log/?id=master
+##
+## instead of
##
-## RewriteRule ^/git/$ /cgit.cgi [L,QSA]
-## RewriteRule ^/git/([^/]+)/$ /cgit.cgi?r=$1 [L,QSA]
-## RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit.cgi?r=$1&p=$2 [L,QSA]
+## http://localhost/cgit/cgit.cgi?r=repo&p=log&id=master
##
+## For this to work with apache, rewrite rules must be added to httpd.conf,
+## possibly looking something like this:
+##
+## RewriteRule ^/git/$ /cgit/cgit.cgi [L,QSA]
+## RewriteRule ^/git/([^/]+)/$ /cgit/cgit.cgi?r=$1 [L,QSA]
+## RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit/cgit.cgi?r=$1&p=$2 [L,QSA]
+##
+## 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
+## Link to css file
+#css=/cgit/cgit.css
-## link to logo file
-#logo=/git-logo.png
+## Link to logo file
+#logo=/cgit/git-logo.png
-## url loaded when clicking the logo
+## 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
+## 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
-
-
-## root path for cached output
+## Root of cached output
#cache-root=/var/cache/cgit
##
-## 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
@@ -60,7 +70,8 @@
-## 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