summaryrefslogtreecommitdiffabout
path: root/cgitrc.5.txt
Unidiff
Diffstat (limited to 'cgitrc.5.txt') (more/less context) (ignore whitespace changes)
-rw-r--r--cgitrc.5.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index fd299ae..771bb7d 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,247 +1,256 @@
1CGITRC 1CGITRC
2====== 2======
3 3
4 4
5NAME 5NAME
6---- 6----
7 cgitrc - runtime configuration for cgit 7 cgitrc - runtime configuration for cgit
8 8
9 9
10DESCRIPTION 10DESCRIPTION
11----------- 11-----------
12Cgitrc contains all runtime settings for cgit, including the list of git 12Cgitrc contains all runtime settings for cgit, including the list of git
13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank 13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
14lines, and lines starting with '#', are ignored. 14lines, and lines starting with '#', are ignored.
15 15
16 16
17GLOBAL SETTINGS 17GLOBAL SETTINGS
18--------------- 18---------------
19agefile 19agefile
20 Specifies a path, relative to each repository path, which can be used 20 Specifies a path, relative to each repository path, which can be used
21 to specify the date and time of the youngest commit in the repository. 21 to specify the date and time of the youngest commit in the repository.
22 The first line in the file is used as input to the "parse_date" 22 The first line in the file is used as input to the "parse_date"
23 function in libgit. Recommended timestamp-format is "yyyy-mm-dd 23 function in libgit. Recommended timestamp-format is "yyyy-mm-dd
24 hh:mm:ss". Default value: "info/web/last-modified". 24 hh:mm:ss". Default value: "info/web/last-modified".
25 25
26cache-root 26cache-root
27 Path used to store the cgit cache entries. Default value: 27 Path used to store the cgit cache entries. Default value:
28 "/var/cache/cgit". 28 "/var/cache/cgit".
29 29
30cache-dynamic-ttl 30cache-dynamic-ttl
31 Number which specifies the time-to-live, in minutes, for the cached 31 Number which specifies the time-to-live, in minutes, for the cached
32 version of repository pages accessed without a fixed SHA1. Default 32 version of repository pages accessed without a fixed SHA1. Default
33 value: "5". 33 value: "5".
34 34
35cache-repo-ttl 35cache-repo-ttl
36 Number which specifies the time-to-live, in minutes, for the cached 36 Number which specifies the time-to-live, in minutes, for the cached
37 version of the repository summary page. Default value: "5". 37 version of the repository summary page. Default value: "5".
38 38
39cache-root-ttl 39cache-root-ttl
40 Number which specifies the time-to-live, in minutes, for the cached 40 Number which specifies the time-to-live, in minutes, for the cached
41 version of the repository index page. Default value: "5". 41 version of the repository index page. Default value: "5".
42 42
43cache-size 43cache-size
44 The maximum number of entries in the cgit cache. Default value: "0" 44 The maximum number of entries in the cgit cache. Default value: "0"
45 (i.e. caching is disabled). 45 (i.e. caching is disabled).
46 46
47cache-static-ttl 47cache-static-ttl
48 Number which specifies the time-to-live, in minutes, for the cached 48 Number which specifies the time-to-live, in minutes, for the cached
49 version of repository pages accessed with a fixed SHA1. Default value: 49 version of repository pages accessed with a fixed SHA1. Default value:
50 "5". 50 "5".
51 51
52clone-prefix 52clone-prefix
53 Space-separated list of common prefixes which, when combined with a 53 Space-separated list of common prefixes which, when combined with a
54 repository url, generates valid clone urls for the repository. This 54 repository url, generates valid clone urls for the repository. This
55 setting is only used if `repo.clone-url` is unspecified. Default value: 55 setting is only used if `repo.clone-url` is unspecified. Default value:
56 none. 56 none.
57 57
58css 58css
59 Url which specifies the css document to include in all cgit pages. 59 Url which specifies the css document to include in all cgit pages.
60 Default value: "/cgit.css". 60 Default value: "/cgit.css".
61 61
62embedded
63 Flag which, when set to "1", will make cgit generate a html fragment
64 suitable for embedding in other html pages. Default value: none. See
65 also: "noheader".
66
62enable-index-links 67enable-index-links
63 Flag which, when set to "1", will make cgit generate extra links for 68 Flag which, when set to "1", will make cgit generate extra links for
64 each repo in the repository index (specifically, to the "summary", 69 each repo in the repository index (specifically, to the "summary",
65 "commit" and "tree" pages). Default value: "0". 70 "commit" and "tree" pages). Default value: "0".
66 71
67enable-log-filecount 72enable-log-filecount
68 Flag which, when set to "1", will make cgit print the number of 73 Flag which, when set to "1", will make cgit print the number of
69 modified files for each commit on the repository log page. Default 74 modified files for each commit on the repository log page. Default
70 value: "0". 75 value: "0".
71 76
72enable-log-linecount 77enable-log-linecount
73 Flag which, when set to "1", will make cgit print the number of added 78 Flag which, when set to "1", will make cgit print the number of added
74 and removed lines for each commit on the repository log page. Default 79 and removed lines for each commit on the repository log page. Default
75 value: "0". 80 value: "0".
76 81
77favicon 82favicon
78 Url used as link to a shortcut icon for cgit. If specified, it is 83 Url used as link to a shortcut icon for cgit. If specified, it is
79 suggested to use the value "/favicon.ico" since certain browsers will 84 suggested to use the value "/favicon.ico" since certain browsers will
80 ignore other values. Default value: none. 85 ignore other values. Default value: none.
81 86
82footer 87footer
83 The content of the file specified with this option will be included 88 The content of the file specified with this option will be included
84 verbatim at the bottom of all pages (i.e. it replaces the standard 89 verbatim at the bottom of all pages (i.e. it replaces the standard
85 "generated by..." message. Default value: none. 90 "generated by..." message. Default value: none.
86 91
87header 92header
88 The content of the file specified with this option will be included 93 The content of the file specified with this option will be included
89 verbatim at the top of all pages. Default value: none. 94 verbatim at the top of all pages. Default value: none.
90 95
91include 96include
92 Name of a configfile to include before the rest of the current config- 97 Name of a configfile to include before the rest of the current config-
93 file is parsed. Default value: none. 98 file is parsed. Default value: none.
94 99
95index-header 100index-header
96 The content of the file specified with this option will be included 101 The content of the file specified with this option will be included
97 verbatim above the repository index. This setting is deprecated, and 102 verbatim above the repository index. This setting is deprecated, and
98 will not be supported by cgit-1.0 (use root-readme instead). Default 103 will not be supported by cgit-1.0 (use root-readme instead). Default
99 value: none. 104 value: none.
100 105
101index-info 106index-info
102 The content of the file specified with this option will be included 107 The content of the file specified with this option will be included
103 verbatim below the heading on the repository index page. This setting 108 verbatim below the heading on the repository index page. This setting
104 is deprecated, and will not be supported by cgit-1.0 (use root-desc 109 is deprecated, and will not be supported by cgit-1.0 (use root-desc
105 instead). Default value: none. 110 instead). Default value: none.
106 111
107local-time 112local-time
108 Flag which, if set to "1", makes cgit print commit and tag times in the 113 Flag which, if set to "1", makes cgit print commit and tag times in the
109 servers timezone. Default value: "0". 114 servers timezone. Default value: "0".
110 115
111logo 116logo
112 Url which specifies the source of an image which will be used as a logo 117 Url which specifies the source of an image which will be used as a logo
113 on all cgit pages. 118 on all cgit pages.
114 119
115logo-link 120logo-link
116 Url loaded when clicking on the cgit logo image. If unspecified the 121 Url loaded when clicking on the cgit logo image. If unspecified the
117 calculated url of the repository index page will be used. Default 122 calculated url of the repository index page will be used. Default
118 value: none. 123 value: none.
119 124
120max-commit-count 125max-commit-count
121 Specifies the number of entries to list per page in "log" view. Default 126 Specifies the number of entries to list per page in "log" view. Default
122 value: "50". 127 value: "50".
123 128
124max-message-length 129max-message-length
125 Specifies the maximum number of commit message characters to display in 130 Specifies the maximum number of commit message characters to display in
126 "log" view. Default value: "80". 131 "log" view. Default value: "80".
127 132
128max-repo-count 133max-repo-count
129 Specifies the number of entries to list per page on therepository 134 Specifies the number of entries to list per page on therepository
130 index page. Default value: "50". 135 index page. Default value: "50".
131 136
132max-repodesc-length 137max-repodesc-length
133 Specifies the maximum number of repo description characters to display 138 Specifies the maximum number of repo description characters to display
134 on the repository index page. Default value: "80". 139 on the repository index page. Default value: "80".
135 140
136max-stats 141max-stats
137 Set the default maximum statistics period. Valid values are "week", 142 Set the default maximum statistics period. Valid values are "week",
138 "month", "quarter" and "year". If unspecified, statistics are 143 "month", "quarter" and "year". If unspecified, statistics are
139 disabled. Default value: none. See also: "repo.max-stats". 144 disabled. Default value: none. See also: "repo.max-stats".
140 145
141module-link 146module-link
142 Text which will be used as the formatstring for a hyperlink when a 147 Text which will be used as the formatstring for a hyperlink when a
143 submodule is printed in a directory listing. The arguments for the 148 submodule is printed in a directory listing. The arguments for the
144 formatstring are the path and SHA1 of the submodule commit. Default 149 formatstring are the path and SHA1 of the submodule commit. Default
145 value: "./?repo=%s&page=commit&id=%s" 150 value: "./?repo=%s&page=commit&id=%s"
146 151
147nocache 152nocache
148 If set to the value "1" caching will be disabled. This settings is 153 If set to the value "1" caching will be disabled. This settings is
149 deprecated, and will not be honored starting with cgit-1.0. Default 154 deprecated, and will not be honored starting with cgit-1.0. Default
150 value: "0". 155 value: "0".
151 156
157noheader
158 Flag which, when set to "1", will make cgit omit the standard header
159 on all pages. Default value: none. See also: "embedded".
160
152renamelimit 161renamelimit
153 Maximum number of files to consider when detecting renames. The value 162 Maximum number of files to consider when detecting renames. The value
154 "-1" uses the compiletime value in git (for further info, look at 163 "-1" uses the compiletime value in git (for further info, look at
155 `man git-diff`). Default value: "-1". 164 `man git-diff`). Default value: "-1".
156 165
157repo.group 166repo.group
158 A value for the current repository group, which all repositories 167 A value for the current repository group, which all repositories
159 specified after this setting will inherit. Default value: none. 168 specified after this setting will inherit. Default value: none.
160 169
161robots 170robots
162 Text used as content for the "robots" meta-tag. Default value: 171 Text used as content for the "robots" meta-tag. Default value:
163 "index, nofollow". 172 "index, nofollow".
164 173
165root-desc 174root-desc
166 Text printed below the heading on the repository index page. Default 175 Text printed below the heading on the repository index page. Default
167 value: "a fast webinterface for the git dscm". 176 value: "a fast webinterface for the git dscm".
168 177
169root-readme: 178root-readme:
170 The content of the file specified with this option will be included 179 The content of the file specified with this option will be included
171 verbatim below the "about" link on the repository index page. Default 180 verbatim below the "about" link on the repository index page. Default
172 value: none. 181 value: none.
173 182
174root-title 183root-title
175 Text printed as heading on the repository index page. Default value: 184 Text printed as heading on the repository index page. Default value:
176 "Git Repository Browser". 185 "Git Repository Browser".
177 186
178snapshots 187snapshots
179 Text which specifies the default (and allowed) set of snapshot formats 188 Text which specifies the default (and allowed) set of snapshot formats
180 supported by cgit. The value is a space-separated list of zero or more 189 supported by cgit. The value is a space-separated list of zero or more
181 of the following values: 190 of the following values:
182 "tar" uncompressed tar-file 191 "tar" uncompressed tar-file
183 "tar.gz"gzip-compressed tar-file 192 "tar.gz"gzip-compressed tar-file
184 "tar.bz2"bzip-compressed tar-file 193 "tar.bz2"bzip-compressed tar-file
185 "zip" zip-file 194 "zip" zip-file
186 Default value: none. 195 Default value: none.
187 196
188summary-branches 197summary-branches
189 Specifies the number of branches to display in the repository "summary" 198 Specifies the number of branches to display in the repository "summary"
190 view. Default value: "10". 199 view. Default value: "10".
191 200
192summary-log 201summary-log
193 Specifies the number of log entries to display in the repository 202 Specifies the number of log entries to display in the repository
194 "summary" view. Default value: "10". 203 "summary" view. Default value: "10".
195 204
196summary-tags 205summary-tags
197 Specifies the number of tags to display in the repository "summary" 206 Specifies the number of tags to display in the repository "summary"
198 view. Default value: "10". 207 view. Default value: "10".
199 208
200virtual-root 209virtual-root
201 Url which, if specified, will be used as root for all cgit links. It 210 Url which, if specified, will be used as root for all cgit links. It
202 will also cause cgit to generate 'virtual urls', i.e. urls like 211 will also cause cgit to generate 'virtual urls', i.e. urls like
203 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 212 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
204 value: none. 213 value: none.
205 NOTE: cgit has recently learned how to use PATH_INFO to achieve the 214 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
206 same kind of virtual urls, so this option will probably be deprecated. 215 same kind of virtual urls, so this option will probably be deprecated.
207 216
208REPOSITORY SETTINGS 217REPOSITORY SETTINGS
209------------------- 218-------------------
210repo.clone-url 219repo.clone-url
211 A list of space-separated urls which can be used to clone this repo. 220 A list of space-separated urls which can be used to clone this repo.
212 Default value: none. 221 Default value: none.
213 222
214repo.defbranch 223repo.defbranch
215 The name of the default branch for this repository. If no such branch 224 The name of the default branch for this repository. If no such branch
216 exists in the repository, the first branch name (when sorted) is used 225 exists in the repository, the first branch name (when sorted) is used
217 as default instead. Default value: "master". 226 as default instead. Default value: "master".
218 227
219repo.desc 228repo.desc
220 The value to show as repository description. Default value: none. 229 The value to show as repository description. Default value: none.
221 230
222repo.enable-log-filecount 231repo.enable-log-filecount
223 A flag which can be used to disable the global setting 232 A flag which can be used to disable the global setting
224 `enable-log-filecount'. Default value: none. 233 `enable-log-filecount'. Default value: none.
225 234
226repo.enable-log-linecount 235repo.enable-log-linecount
227 A flag which can be used to disable the global setting 236 A flag which can be used to disable the global setting
228 `enable-log-linecount'. Default value: none. 237 `enable-log-linecount'. Default value: none.
229 238
230repo.max-stats 239repo.max-stats
231 Override the default maximum statistics period. Valid values are equal 240 Override the default maximum statistics period. Valid values are equal
232 to the values specified for the global "max-stats" setting. Default 241 to the values specified for the global "max-stats" setting. Default
233 value: none. 242 value: none.
234 243
235repo.name 244repo.name
236 The value to show as repository name. Default value: <repo.url>. 245 The value to show as repository name. Default value: <repo.url>.
237 246
238repo.owner 247repo.owner
239 A value used to identify the owner of the repository. Default value: 248 A value used to identify the owner of the repository. Default value:
240 none. 249 none.
241 250
242repo.path 251repo.path
243 An absolute path to the repository directory. For non-bare repositories 252 An absolute path to the repository directory. For non-bare repositories
244 this is the .git-directory. Default value: none. 253 this is the .git-directory. Default value: none.
245 254
246repo.readme 255repo.readme
247 A path (relative to <repo.path>) which specifies a file to include 256 A path (relative to <repo.path>) which specifies a file to include