aboutsummaryrefslogtreecommitdiffstats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt122
1 files changed, 64 insertions, 58 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index 771bb7d..a207fe0 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,14 +1,14 @@
1CGITRC 1CGITRC(5)
2====== 2========
3 3
4 4
5NAME 5NAME
6---- 6----
7 cgitrc - runtime configuration for cgit 7cgitrc - runtime configuration for cgit
8 8
9 9
10DESCRIPTION 10SYNOPSIS
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.
@@ -16,175 +16,179 @@ lines, and lines starting with '#', are ignored.
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 62embedded::
63 Flag which, when set to "1", will make cgit generate a html fragment 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 64 suitable for embedding in other html pages. Default value: none. See
65 also: "noheader". 65 also: "noheader".
66 66
67enable-index-links 67enable-index-links::
68 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
69 each repo in the repository index (specifically, to the "summary", 69 each repo in the repository index (specifically, to the "summary",
70 "commit" and "tree" pages). Default value: "0". 70 "commit" and "tree" pages). Default value: "0".
71 71
72enable-log-filecount 72enable-log-filecount::
73 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
74 modified files for each commit on the repository log page. Default 74 modified files for each commit on the repository log page. Default
75 value: "0". 75 value: "0".
76 76
77enable-log-linecount 77enable-log-linecount::
78 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
79 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
80 value: "0". 80 value: "0".
81 81
82favicon 82favicon::
83 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
84 suggested to use the value "/favicon.ico" since certain browsers will 84 suggested to use the value "/favicon.ico" since certain browsers will
85 ignore other values. Default value: none. 85 ignore other values. Default value: none.
86 86
87footer 87footer::
88 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
89 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
90 "generated by..." message. Default value: none. 90 "generated by..." message. Default value: none.
91 91
92header 92head-include::
93 The content of the file specified with this option will be included
94 verbatim in the html HEAD section on all pages. Default value: none.
95
96header::
93 The content of the file specified with this option will be included 97 The content of the file specified with this option will be included
94 verbatim at the top of all pages. Default value: none. 98 verbatim at the top of all pages. Default value: none.
95 99
96include 100include::
97 Name of a configfile to include before the rest of the current config- 101 Name of a configfile to include before the rest of the current config-
98 file is parsed. Default value: none. 102 file is parsed. Default value: none.
99 103
100index-header 104index-header::
101 The content of the file specified with this option will be included 105 The content of the file specified with this option will be included
102 verbatim above the repository index. This setting is deprecated, and 106 verbatim above the repository index. This setting is deprecated, and
103 will not be supported by cgit-1.0 (use root-readme instead). Default 107 will not be supported by cgit-1.0 (use root-readme instead). Default
104 value: none. 108 value: none.
105 109
106index-info 110index-info::
107 The content of the file specified with this option will be included 111 The content of the file specified with this option will be included
108 verbatim below the heading on the repository index page. This setting 112 verbatim below the heading on the repository index page. This setting
109 is deprecated, and will not be supported by cgit-1.0 (use root-desc 113 is deprecated, and will not be supported by cgit-1.0 (use root-desc
110 instead). Default value: none. 114 instead). Default value: none.
111 115
112local-time 116local-time::
113 Flag which, if set to "1", makes cgit print commit and tag times in the 117 Flag which, if set to "1", makes cgit print commit and tag times in the
114 servers timezone. Default value: "0". 118 servers timezone. Default value: "0".
115 119
116logo 120logo::
117 Url which specifies the source of an image which will be used as a logo 121 Url which specifies the source of an image which will be used as a logo
118 on all cgit pages. 122 on all cgit pages.
119 123
120logo-link 124logo-link::
121 Url loaded when clicking on the cgit logo image. If unspecified the 125 Url loaded when clicking on the cgit logo image. If unspecified the
122 calculated url of the repository index page will be used. Default 126 calculated url of the repository index page will be used. Default
123 value: none. 127 value: none.
124 128
125max-commit-count 129max-commit-count::
126 Specifies the number of entries to list per page in "log" view. Default 130 Specifies the number of entries to list per page in "log" view. Default
127 value: "50". 131 value: "50".
128 132
129max-message-length 133max-message-length::
130 Specifies the maximum number of commit message characters to display in 134 Specifies the maximum number of commit message characters to display in
131 "log" view. Default value: "80". 135 "log" view. Default value: "80".
132 136
133max-repo-count 137max-repo-count::
134 Specifies the number of entries to list per page on the repository 138 Specifies the number of entries to list per page on the repository
135 index page. Default value: "50". 139 index page. Default value: "50".
136 140
137max-repodesc-length 141max-repodesc-length::
138 Specifies the maximum number of repo description characters to display 142 Specifies the maximum number of repo description characters to display
139 on the repository index page. Default value: "80". 143 on the repository index page. Default value: "80".
140 144
141max-stats 145max-stats::
142 Set the default maximum statistics period. Valid values are "week", 146 Set the default maximum statistics period. Valid values are "week",
143 "month", "quarter" and "year". If unspecified, statistics are 147 "month", "quarter" and "year". If unspecified, statistics are
144 disabled. Default value: none. See also: "repo.max-stats". 148 disabled. Default value: none. See also: "repo.max-stats".
145 149
146module-link 150module-link::
147 Text which will be used as the formatstring for a hyperlink when a 151 Text which will be used as the formatstring for a hyperlink when a
148 submodule is printed in a directory listing. The arguments for the 152 submodule is printed in a directory listing. The arguments for the
149 formatstring are the path and SHA1 of the submodule commit. Default 153 formatstring are the path and SHA1 of the submodule commit. Default
150 value: "./?repo=%s&page=commit&id=%s" 154 value: "./?repo=%s&page=commit&id=%s"
151 155
152nocache 156nocache::
153 If set to the value "1" caching will be disabled. This settings is 157 If set to the value "1" caching will be disabled. This settings is
154 deprecated, and will not be honored starting with cgit-1.0. Default 158 deprecated, and will not be honored starting with cgit-1.0. Default
155 value: "0". 159 value: "0".
156 160
157noheader 161noheader::
158 Flag which, when set to "1", will make cgit omit the standard header 162 Flag which, when set to "1", will make cgit omit the standard header
159 on all pages. Default value: none. See also: "embedded". 163 on all pages. Default value: none. See also: "embedded".
160 164
161renamelimit 165renamelimit::
162 Maximum number of files to consider when detecting renames. The value 166 Maximum number of files to consider when detecting renames. The value
163 "-1" uses the compiletime value in git (for further info, look at 167 "-1" uses the compiletime value in git (for further info, look at
164 `man git-diff`). Default value: "-1". 168 `man git-diff`). Default value: "-1".
165 169
166repo.group 170repo.group::
167 A value for the current repository group, which all repositories 171 A value for the current repository group, which all repositories
168 specified after this setting will inherit. Default value: none. 172 specified after this setting will inherit. Default value: none.
169 173
170robots 174robots::
171 Text used as content for the "robots" meta-tag. Default value: 175 Text used as content for the "robots" meta-tag. Default value:
172 "index, nofollow". 176 "index, nofollow".
173 177
174root-desc 178root-desc::
175 Text printed below the heading on the repository index page. Default 179 Text printed below the heading on the repository index page. Default
176 value: "a fast webinterface for the git dscm". 180 value: "a fast webinterface for the git dscm".
177 181
178root-readme: 182root-readme::
179 The content of the file specified with this option will be included 183 The content of the file specified with this option will be included
180 verbatim below the "about" link on the repository index page. Default 184 verbatim below the "about" link on the repository index page. Default
181 value: none. 185 value: none.
182 186
183root-title 187root-title::
184 Text printed as heading on the repository index page. Default value: 188 Text printed as heading on the repository index page. Default value:
185 "Git Repository Browser". 189 "Git Repository Browser".
186 190
187snapshots 191snapshots::
188 Text which specifies the default (and allowed) set of snapshot formats 192 Text which specifies the default (and allowed) set of snapshot formats
189 supported by cgit. The value is a space-separated list of zero or more 193 supported by cgit. The value is a space-separated list of zero or more
190 of the following values: 194 of the following values:
@@ -194,19 +198,19 @@ snapshots
194 "zip" zip-file 198 "zip" zip-file
195 Default value: none. 199 Default value: none.
196 200
197summary-branches 201summary-branches::
198 Specifies the number of branches to display in the repository "summary" 202 Specifies the number of branches to display in the repository "summary"
199 view. Default value: "10". 203 view. Default value: "10".
200 204
201summary-log 205summary-log::
202 Specifies the number of log entries to display in the repository 206 Specifies the number of log entries to display in the repository
203 "summary" view. Default value: "10". 207 "summary" view. Default value: "10".
204 208
205summary-tags 209summary-tags::
206 Specifies the number of tags to display in the repository "summary" 210 Specifies the number of tags to display in the repository "summary"
207 view. Default value: "10". 211 view. Default value: "10".
208 212
209virtual-root 213virtual-root::
210 Url which, if specified, will be used as root for all cgit links. It 214 Url which, if specified, will be used as root for all cgit links. It
211 will also cause cgit to generate 'virtual urls', i.e. urls like 215 will also cause cgit to generate 'virtual urls', i.e. urls like
212 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default 216 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
@@ -216,51 +220,51 @@ virtual-root
216 220
217REPOSITORY SETTINGS 221REPOSITORY SETTINGS
218------------------- 222-------------------
219repo.clone-url 223repo.clone-url::
220 A list of space-separated urls which can be used to clone this repo. 224 A list of space-separated urls which can be used to clone this repo.
221 Default value: none. 225 Default value: none.
222 226
223repo.defbranch 227repo.defbranch::
224 The name of the default branch for this repository. If no such branch 228 The name of the default branch for this repository. If no such branch
225 exists in the repository, the first branch name (when sorted) is used 229 exists in the repository, the first branch name (when sorted) is used
226 as default instead. Default value: "master". 230 as default instead. Default value: "master".
227 231
228repo.desc 232repo.desc::
229 The value to show as repository description. Default value: none. 233 The value to show as repository description. Default value: none.
230 234
231repo.enable-log-filecount 235repo.enable-log-filecount::
232 A flag which can be used to disable the global setting 236 A flag which can be used to disable the global setting
233 `enable-log-filecount'. Default value: none. 237 `enable-log-filecount'. Default value: none.
234 238
235repo.enable-log-linecount 239repo.enable-log-linecount::
236 A flag which can be used to disable the global setting 240 A flag which can be used to disable the global setting
237 `enable-log-linecount'. Default value: none. 241 `enable-log-linecount'. Default value: none.
238 242
239repo.max-stats 243repo.max-stats::
240 Override the default maximum statistics period. Valid values are equal 244 Override the default maximum statistics period. Valid values are equal
241 to the values specified for the global "max-stats" setting. Default 245 to the values specified for the global "max-stats" setting. Default
242 value: none. 246 value: none.
243 247
244repo.name 248repo.name::
245 The value to show as repository name. Default value: <repo.url>. 249 The value to show as repository name. Default value: <repo.url>.
246 250
247repo.owner 251repo.owner::
248 A value used to identify the owner of the repository. Default value: 252 A value used to identify the owner of the repository. Default value:
249 none. 253 none.
250 254
251repo.path 255repo.path::
252 An absolute path to the repository directory. For non-bare repositories 256 An absolute path to the repository directory. For non-bare repositories
253 this is the .git-directory. Default value: none. 257 this is the .git-directory. Default value: none.
254 258
255repo.readme 259repo.readme::
256 A path (relative to <repo.path>) which specifies a file to include 260 A path (relative to <repo.path>) which specifies a file to include
257 verbatim as the "About" page for this repo. Default value: none. 261 verbatim as the "About" page for this repo. Default value: none.
258 262
259repo.snapshots 263repo.snapshots::
260 A mask of allowed snapshot-formats for this repo, restricted by the 264 A mask of allowed snapshot-formats for this repo, restricted by the
261 "snapshots" global setting. Default value: <snapshots>. 265 "snapshots" global setting. Default value: <snapshots>.
262 266
263repo.url 267repo.url::
264 The relative url used to access the repository. This must be the first 268 The relative url used to access the repository. This must be the first
265 setting specified for each repo. Default value: none. 269 setting specified for each repo. Default value: none.
266 270
@@ -268,6 +272,7 @@ repo.url
268EXAMPLE CGITRC FILE 272EXAMPLE CGITRC FILE
269------------------- 273-------------------
270 274
275....
271# Enable caching of up to 1000 output entriess 276# Enable caching of up to 1000 output entriess
272cache-size=1000 277cache-size=1000
273 278
@@ -377,6 +382,7 @@ repo.enable-log-linecount=0
377 382
378# Restrict the max statistics period for this repo 383# Restrict the max statistics period for this repo
379repo.max-stats=month 384repo.max-stats=month
385....
380 386
381 387
382BUGS 388BUGS