about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorLars Hjemli2007-02-04 23:24:08 +0100
committerLars Hjemli2007-02-04 23:24:08 +0100
commit74b0db95560e4c11439d7e0e8016d1e8cd48cdda (patch)
tree3bc0b9c2a5fb171562e72cb79945b7527670f651
parentAdd support for lightweight tags (diff)
downloadcgit-74b0db95560e4c11439d7e0e8016d1e8cd48cdda.tar.gz
cgit-74b0db95560e4c11439d7e0e8016d1e8cd48cdda.zip
Update cgitrc template
Make the descriptions more helpfull.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
-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 @@
3## 3##
4 4
5 5
6## base for virtual urls. If specified, rewrite rules must be added to 6## Uncomment and set to 1 to deactivate caching of generated pages. Mostly
7## httpd.conf. Possible rules for /git/ when cgit.cgi is accessed as /cgit.cgi: 7## usefull for testing.
8#nocache=0
9
10
11## Specify a root for virtual urls. This makes cgit generate urls like
12##
13## http://localhost/git/repo/log/?id=master
14##
15## instead of
8## 16##
9## RewriteRule ^/git/$ /cgit.cgi [L,QSA] 17## http://localhost/cgit/cgit.cgi?r=repo&p=log&id=master
10## RewriteRule ^/git/([^/]+)/$ /cgit.cgi?r=$1 [L,QSA]
11## RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit.cgi?r=$1&p=$2 [L,QSA]
12## 18##
19## For this to work with apache, rewrite rules must be added to httpd.conf,
20## possibly looking something like this:
21##
22## RewriteRule ^/git/$ /cgit/cgit.cgi [L,QSA]
23## RewriteRule ^/git/([^/]+)/$ /cgit/cgit.cgi?r=$1 [L,QSA]
24## RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit/cgit.cgi?r=$1&p=$2 [L,QSA]
25##
26## This setting is disabled by default.
13#virtual-root=/git 27#virtual-root=/git
14 28
15 29
16## page title for the root page (repo listing) 30## Set the title printed on the root page
17#root-title=Git repository browser 31#root-title=Git repository browser
18 32
19 33
20## link to css file 34## Link to css file
21#css=/cgit.css 35#css=/cgit/cgit.css
22 36
23 37
24## link to logo file 38## Link to logo file
25#logo=/git-logo.png 39#logo=/cgit/git-logo.png
26 40
27 41
28## url loaded when clicking the logo 42## Url loaded when clicking the logo
29#logo-link=http://www.kernel.org/pub/software/scm/git/docs/ 43#logo-link=http://www.kernel.org/pub/software/scm/git/docs/
30 44
31 45
32## set number of initial chars to show of commit subject message in log views 46## Number of chars shown of commit subject message (in log view)
33#max-message-length=60 47#max-message-length=60
34 48
35 49
36## Set to 1 to deactivate caching of generated pages 50## Root of cached output
37#nocache=0
38
39
40## root path for cached output
41#cache-root=/var/cache/cgit 51#cache-root=/var/cache/cgit
42 52
43 53
44## 54##
45## Time-To-Live settings: specify how long (in minutes) different pages should 55## Time-To-Live settings: specifies how long (in minutes) different pages
46## be cached. Specify 0 for instant expiration and -1 for immortal pages 56## should be cached (0 for instant expiration, -1 for immortal pages)
47## 57##
48 58
49## ttl for root page (repo listing) 59## ttl for root page
50#cache-root-ttl=5 60#cache-root-ttl=5
51 61
52## ttl for repo summary page 62## ttl for repo summary page
@@ -60,7 +70,8 @@
60 70
61 71
62 72
63## Example repository entry 73## Example repository entry. Required values are repo.url and repo.path (each
74## repository section must start with repo.url).
64#repo.url=cgit 75#repo.url=cgit
65#repo.name=cgit 76#repo.name=cgit
66#repo.desc=the caching cgi for git 77#repo.desc=the caching cgi for git