about summary refs log tree commit diff stats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--cgitrc202
-rw-r--r--cgitrc.5.txt367
2 files changed, 367 insertions, 202 deletions
diff --git a/cgitrc b/cgitrc deleted file mode 100644 index 6a79c43..0000000 --- a/cgitrc +++ /dev/null
@@ -1,202 +0,0 @@
1##
2## cgitrc: template for /etc/cgitrc
3##
4
5
6## Uncomment and set to 1 to deactivate caching of generated pages. Mostly
7## usefull for testing.
8#nocache=0
9
10
11## This variable can be used to override the default value for "robots"
12## meta-tag. If unset, the meta-tag isn't generated.
13#robots=index, nofollow
14
15
16## Set allowed snapshot types by default. Can be overridden per repo
17# can be any combination of zip/tar.gz/tar.bz2/tar
18#snapshots=0
19
20
21## Enable/disable extra links to summary/log/tree per repo on index page
22#enable-index-links=0
23
24
25## Enable/disable display of 'number of files changed' in log view
26#enable-log-filecount=0
27
28
29## Enable/disable display of 'number of lines changed' in log view
30#enable-log-linecount=0
31
32
33## Enable/disable display of HEAD shortlog in summary view. Set it to maximum
34## number of commits that should be displayed
35#summary-log=0
36
37
38## Restrict the number of branches printed in summary view. Set to 0 to
39## print all branches.
40#summary-branches=0
41
42
43## Restrict the number of tags printed in summary view. Set to 0 to
44## print all tags.
45#summary-tags=0
46
47## Enable/disable display of localtime vs. GMT. Set to 1 for localtime.
48#local-time=0
49
50## The "Idle" column on the repository index page can read a timestamp
51## from the specified agefile (if this file cannot be found, the mtime
52## of HEAD is used).
53## The cgit repo on hjemli.net uses the the following command in it's
54## post-receive hook to update the age-file:
55## git-for-each-ref --format="%(committerdate)" --sort=-committerdate \
56## --count=1 > $GIT_DIR/info/web/last-modifie
57##
58#agefile=info/web/last-modified
59
60
61## Git detects renames, but with a limit on the number of files to
62## consider. This option can be used to specify another limit (or -1 to
63## use the default limit).
64##
65#renamelimit=-1
66
67
68## Specify a root for virtual urls. This makes cgit generate urls like
69##
70## http://localhost/git/repo/log/?h=branch
71##
72## instead of
73##
74## http://localhost/cgit/cgit.cgi?url=repo/log&h=branch
75##
76## For this to work with apache, a rewrite rule must be added to httpd.conf,
77## possibly looking something like this:
78##
79## RewriteRule ^/git/(.*)$ /cgit/cgit.cgi?url=$1 [L,QSA]
80##
81## For this to work with lighttpd, the rewrite rule should look more like this:
82##
83## url.rewrite = (
84## "^/git/([^?/]+/[^?]*)?(?:\?(.*))?$" => "/cgit.cgi?url=$1&$2"
85## )
86##
87## This setting is disabled by default.
88#virtual-root=/git
89
90
91## Set the title printed on the root page
92#root-title=Git repository browser
93
94
95## Set the description printed on the root page
96#root-desc=a fast web interface for the git dscm
97
98
99## If specified, the file at this path will be included as HTML in the
100## sidebar on the repository index page
101#index-info=
102
103
104## If specified, the file at this path will be included as HTML above
105## the repository index
106#index-header=
107
108
109## Link to css file
110#css=/cgit/cgit.css
111
112## Link to favicon
113#favicon=/favicon.ico
114
115## Link to logo file
116#logo=/cgit/git-logo.png
117
118
119## Url loaded when clicking the logo
120#logo-link=http://www.kernel.org/pub/software/scm/git/docs/
121
122
123## Url loaded when clicking a submodule link
124#module-link=./?repo=%s&page=commit&id=%s
125
126
127## Shared prefix which, when combined with repo url, becomes the url used
128## to clone the repo
129#clone-prefix=
130
131
132## Number of chars shown of repo description (in repolist view)
133#max-repodesc-length=60
134
135
136## Number of chars shown of commit subject message (in log view)
137#max-message-length=60
138
139
140## Number of commits per page in log view
141#max-commit-count=50
142
143
144## Root of cached output
145#cache-root=/var/cache/cgit
146
147
148## Include another config-file
149#include=/var/cgit/repolist
150
151##
152## Time-To-Live settings: specifies how long (in minutes) different pages
153## should be cached (0 for instant expiration, -1 for immortal pages)
154##
155
156## ttl for root page
157#cache-root-ttl=5
158
159## ttl for repo summary page
160#cache-repo-ttl=5
161
162## ttl for other dynamic pages
163#cache-dynamic-ttl=5
164
165## ttl for static pages (addressed by SHA-1)
166#cache-static-ttl=-1
167
168
169
170## Example repository entry. Required values are repo.url and repo.path (each
171## repository section must start with repo.url).
172#repo.url=cgit
173#repo.name=cgit
174#repo.desc=the caching cgi for git
175#repo.path=/pub/git/cgit ## this is the path to $GIT_DIR
176#repo.owner=Lars Hjemli
177#repo.defbranch=master ## define a default branch
178#repo.snapshots=tar.bz2 ## override a sitewide snapshot-setting
179#repo.enable-log-filecount=0 ## override the default filecount setting
180#repo.enable-log-linecount=0 ## override the default linecount setting
181#repo.module-link=/git/%s/commit/?id=%s ## override the standard module-link
182#repo.readme=info/web/readme ## specify a file to include on summary page
183#repo.clone-url=git://hjemli.net/pub/git/cgit
184
185## Additional repositories grouped under "mirrors"
186#repo.group=mirrors
187
188#repo.url=git
189#repo.path=/pub/git/git
190#repo.clone-url=git://hjemli.net/pub/git/git
191#
192#repo.url=linux
193#repo.path=/pub/git/linux
194
195## A group of private repositories (with a working directory)
196#repo.group=private
197
198#repo.url=larsh/cgit
199#repo.path=/home/larsh/src/cgit/.git
200
201#repo.url=larsh/git
202#repo.path=/home/larsh/src/git/.git
diff --git a/cgitrc.5.txt b/cgitrc.5.txt new file mode 100644 index 0000000..7887b02 --- /dev/null +++ b/cgitrc.5.txt
@@ -0,0 +1,367 @@
1CGITRC
2======
3
4
5NAME
6----
7 cgitrc - runtime configuration for cgit
8
9
10DESCRIPTION
11-----------
12Cgitrc contains all runtime settings for cgit, including the list of git
13repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
14lines, and lines starting with '#', are ignored.
15
16
17GLOBAL SETTINGS
18---------------
19agefile
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.
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
24 hh:mm:ss". Default value: "info/web/last-modified".
25
26cache-root
27 Path used to store the cgit cache entries. Default value:
28 "/var/cache/cgit".
29
30cache-dynamic-ttl
31 Number which specifies the time-to-live, in minutes, for the cached
32 version of repository pages accessed without a fixed SHA1. Default
33 value: "5".
34
35cache-repo-ttl
36 Number which specifies the time-to-live, in minutes, for the cached
37 version of the repository summary page. Default value: "5".
38
39cache-root-ttl
40 Number which specifies the time-to-live, in minutes, for the cached
41 version of the repository index page. Default value: "5".
42
43cache-size
44 The maximum number of entries in the cgit cache. Default value: "0"
45 (i.e. caching is disabled).
46
47cache-static-ttl
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:
50 "5".
51
52clone-prefix
53 Space-separated list of common prefixes which, when combined with a
54 repository url, generates valid clone urls for the repository. This
55 setting is only used if `repo.clone-url` is unspecified. Default value:
56 none.
57
58css
59 Url which specifies the css document to include in all cgit pages.
60 Default value: "/cgit.css".
61
62enable-index-links
63 Flag which, when set to "1", will make cgit generate extra links for
64 each repo in the repository index (specifically, to the "summary",
65 "commit" and "tree" pages). Default value: "0".
66
67enable-log-filecount
68 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
70 value: "0".
71
72enable-log-linecount
73 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
75 value: "0".
76
77favicon
78 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
80 ignore other values. Default value: none.
81
82footer
83 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
85 "generated by..." message. Default value: none.
86
87include
88 Name of a configfile to include before the rest of the current config-
89 file is parsed. Default value: none.
90
91index-header
92 The content of the file specified with this option will be included
93 verbatim above the repository index. This setting is deprecated, and
94 will not be supported by cgit-1.0 (use root-readme instead). Default
95 value: none.
96
97index-info
98 The content of the file specified with this option will be included
99 verbatim below the heading on the repository index page. This setting
100 is deprecated, and will not be supported by cgit-1.0 (use root-desc
101 instead). Default value: none.
102
103local-time
104 Flag which, if set to "1", makes cgit print commit and tag times in the
105 servers timezone. Default value: "0".
106
107logo
108 Url which specifies the source of an image which will be used as a logo
109 on all cgit pages.
110
111logo-link
112 Url loaded when clicking on the cgit logo image. If unspecified the
113 calculated url of the repository index page will be used. Default
114 value: none.
115
116max-commit-count
117 Specifies the number of entries to list per page in "log" view. Default
118 value: "50".
119
120max-message-length
121 Specifies the maximum number of commit message characters to display in
122 "log" view. Default value: "80".
123
124max-repo-count
125 Specifies the number of entries to list per page on the repository
126 index page. Default value: "50".
127
128max-repodesc-length
129 Specifies the maximum number of repo description characters to display
130 on the repository index page. Default value: "80".
131
132module-link
133 Text which will be used as the formatstring for a hyperlink when a
134 submodule is printed in a directory listing. The arguments for the
135 formatstring are the path and SHA1 of the submodule commit. Default
136 value: "./?repo=%s&page=commit&id=%s"
137
138nocache
139 If set to the value "1" caching will be disabled. This settings is
140 deprecated, and will not be honored starting with cgit-1.0. Default
141 value: "0".
142
143renamelimit
144 Maximum number of files to consider when detecting renames. The value
145 "-1" uses the compiletime value in git (for further info, look at
146 `man git-diff`). Default value: "-1".
147
148repo.group
149 A value for the current repository group, which all repositories
150 specified after this setting will inherit. Default value: none.
151
152robots
153 Text used as content for the "robots" meta-tag. Default value:
154 "index, nofollow".
155
156root-desc
157 Text printed below the heading on the repository index page. Default
158 value: "a fast webinterface for the git dscm".
159
160root-readme:
161 The content of the file specified with this option will be included
162 verbatim below the "about" link on the repository index page. Default
163 value: none.
164
165root-title
166 Text printed as heading on the repository index page. Default value:
167 "Git Repository Browser".
168
169snapshots
170 Text which specifies the default (and allowed) set of snapshot formats
171 supported by cgit. The value is a space-separated list of zero or more
172 of the following values:
173 "tar" uncompressed tar-file
174 "tar.gz" gzip-compressed tar-file
175 "tar.bz2" bzip-compressed tar-file
176 "zip" zip-file
177 Default value: none.
178
179summary-branches
180 Specifies the number of branches to display in the repository "summary"
181 view. Default value: "10".
182
183summary-log
184 Specifies the number of log entries to display in the repository
185 "summary" view. Default value: "10".
186
187summary-tags
188 Specifies the number of tags to display in the repository "summary"
189 view. Default value: "10".
190
191virtual-root
192 Url which, if specified, will be used as root for all cgit links. It
193 will also cause cgit to generate 'virtual urls', i.e. urls like
194 '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
195 value: none.
196 NOTE: cgit has recently learned how to use PATH_INFO to achieve the
197 same kind of virtual urls, so this option will probably be deprecated.
198
199REPOSITORY SETTINGS
200-------------------
201repo.clone-url
202 A list of space-separated urls which can be used to clone this repo.
203 Default value: none.
204
205repo.defbranch
206 The name of the default branch for this repository. If no such branch
207 exists in the repository, the first branch name (when sorted) is used
208 as default instead. Default value: "master".
209
210repo.desc
211 The value to show as repository description. Default value: none.
212
213repo.enable-log-filecount
214 A flag which can be used to disable the global setting
215 `enable-log-filecount'. Default value: none.
216
217repo.enable-log-linecount
218 A flag which can be used to disable the global setting
219 `enable-log-linecount'. Default value: none.
220
221repo.name
222 The value to show as repository name. Default value: <repo.url>.
223
224repo.owner
225 A value used to identify the owner of the repository. Default value:
226 none.
227
228repo.path
229 An absolute path to the repository directory. For non-bare repositories
230 this is the .git-directory. Default value: none.
231
232repo.readme
233 A path (relative to <repo.path>) which specifies a file to include
234 verbatim as the "About" page for this repo. Default value: none.
235
236repo.snapshots
237 A mask of allowed snapshot-formats for this repo, restricted by the
238 "snapshots" global setting. Default value: <snapshots>.
239
240repo.url
241 The relative url used to access the repository. This must be the first
242 setting specified for each repo. Default value: none.
243
244
245EXAMPLE CGITRC FILE
246-------------------
247
248# Enable caching of up to 1000 output entriess
249cache-size=1000
250
251
252# Specify some default clone prefixes
253clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git
254
255# Specify the css url
256css=/css/cgit.css
257
258
259# Show extra links for each repository on the index page
260enable-index-links=1
261
262
263# Show number of affected files per commit on the log pages
264enable-log-filecount=1
265
266
267# Show number of added/removed lines per commit on the log pages
268enable-log-linecount=1
269
270
271# Add a cgit favicon
272favicon=/favicon.ico
273
274
275# Use a custom logo
276logo=/img/mylogo.png
277
278
279# Set the title and heading of the repository index page
280root-title=foobar.com git repositories
281
282
283# Set a subheading for the repository index page
284root-desc=tracking the foobar development
285
286
287# Include some more info about foobar.com on the index page
288root-readme=/var/www/htdocs/about.html
289
290
291# Allow download of tar.gz, tar.bz and zip-files
292snapshots=tar.gz tar.bz zip
293
294
295##
296## List of repositories.
297## PS: Any repositories listed when repo.group is unset will not be
298## displayed under a group heading
299## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos')
300## and included like this:
301## include=/etc/cgitrepos
302##
303
304
305repo.url=foo
306repo.path=/pub/git/foo.git
307repo.desc=the master foo repository
308repo.owner=fooman@foobar.com
309repo.readme=info/web/about.html
310
311
312repo.url=bar
313repo.path=/pub/git/bar.git
314repo.desc=the bars for your foo
315repo.owner=barman@foobar.com
316repo.readme=info/web/about.html
317
318
319# The next repositories will be displayed under the 'extras' heading
320repo.group=extras
321
322
323repo.url=baz
324repo.path=/pub/git/baz.git
325repo.desc=a set of extensions for bar users
326
327repo.url=wiz
328repo.path=/pub/git/wiz.git
329repo.desc=the wizard of foo
330
331
332# Add some mirrored repositories
333repo.group=mirrors
334
335
336repo.url=git
337repo.path=/pub/git/git.git
338repo.desc=the dscm
339
340
341repo.url=linux
342repo.path=/pub/git/linux.git
343repo.desc=the kernel
344
345# Disable adhoc downloads of this repo
346repo.snapshots=0
347
348# Disable line-counts for this repo
349repo.enable-log-linecount=0
350
351
352BUGS
353----
354Comments currently cannot appear on the same line as a setting; the comment
355will be included as part of the value. E.g. this line:
356
357 robots=index # allow indexing
358
359will generate the following html element:
360
361 <meta name='robots' content='index # allow indexing'/>
362
363
364
365AUTHOR
366------
367Lars Hjemli <hjemli@gmail.com>
© 2022 C. Duckworth. generated by cgit. comments, issues, and patches welcome at < git at acdw dot net >.