7 From the git version 1.4.0 gitweb is bundled with git.
10 How to configure gitweb for your local system
11 ---------------------------------------------
13 See also the "Build time configuration" section in the INSTALL
14 file for gitweb (in gitweb/INSTALL).
16 You can specify the following configuration variables when building GIT:
18 Points where to find the git executable. You should set it up to
19 the place where the git binary was installed (usually /usr/bin) if you
20 don't install git from sources together with gitweb. [Default: $(bindir)]
22 Shown in the title of all generated pages, defaults to the server name
23 (SERVER_NAME CGI environment variable) if not set. [No default]
25 The root directory for all projects shown by gitweb. Must be set
26 correctly for gitweb to find repositories to display. See also
27 "Gitweb repositories" in the INSTALL file for gitweb. [Default: /pub/git]
28 * GITWEB_PROJECT_MAXDEPTH
29 The filesystem traversing limit for getting the project list; the number
30 is taken as depth relative to the projectroot. It is used when
31 GITWEB_LIST is a directory (or is not set; then project root is used).
32 Is is meant to speed up project listing on large work trees by limiting
33 search depth. [Default: 2007]
35 Points to a directory to scan for projects (defaults to project root
36 if not set / if empty) or to a file with explicit listing of projects
37 (together with projects' ownership). See "Generating projects list
38 using gitweb" in INSTALL file for gitweb to find out how to generate
39 such file from scan of a directory. [No default, which means use root
40 directory for projects]
42 Show repository only if this file exists (in repository). Only
43 effective if this variable evaluates to true. [No default / Not set]
44 * GITWEB_STRICT_EXPORT
45 Only allow viewing of repositories also shown on the overview page.
46 This for example makes GITWEB_EXPORT_OK to decide if repository is
47 available and not only if it is shown. If GITWEB_LIST points to
48 file with list of project, only those repositories listed would be
49 available for gitweb. [No default]
51 Points to an .html file which is included on the gitweb project
52 overview page ('projects_list' view), if it exists. Relative to
53 gitweb.cgi script. [Default: indextext.html]
55 Filename of html text to include at top of each page. Relative to
56 gitweb.cgi script. [No default]
58 Filename of html text to include at bottom of each page. Relative to
59 gitweb.cgi script. [No default]
60 * GITWEB_HOME_LINK_STR
61 String of the home link on top of all pages, leading to $home_link
62 (usually main gitweb page, which means projects list). Used as first
63 part of gitweb view "breadcrumb trail": <home> / <project> / <view>.
66 Name of your site or organization to appear in page titles. Set it
67 to something descriptive for clearer bookmarks etc. If not set
68 (if empty) gitweb uses "$SERVER_NAME Git", or "Untitled Git" if
69 SERVER_NAME CGI environment variable is not set (e.g. if running
70 gitweb as standalone script). [No default]
72 Git base URLs used for URL to where fetch project from, i.e. full
73 URL is "$git_base_url/$project". Shown on projects summary page.
74 Repository URL for project can be also configured per repository; this
75 takes precedence over URLs composed from base URL and a project name.
76 Note that you can setup multiple base URLs (for example one for
77 git:// protocol access, another for http:// access) from the gitweb
78 config file. [No default]
80 Points to the location where you put gitweb.css on your web server
81 (or to be more generic, the URI of gitweb stylesheet). Relative to the
82 base URI of gitweb. Note that you can setup multiple stylesheets from
83 the gitweb config file. [Default: gitweb.css]
85 Points to the location where you put git-logo.png on your web server
86 (or to be more generic URI of logo, 72x27 size, displayed in top right
87 corner of each gitweb page, and used as logo for Atom feed). Relative
88 to base URI of gitweb. [Default: git-logo.png]
90 Points to the location where you put git-favicon.png on your web server
91 (or to be more generic URI of favicon, assumed to be image/png type;
92 web browsers that support favicons (website icons) may display them
93 in the browser's URL bar and next to site name in bookmarks). Relative
94 to base URI of gitweb. [Default: git-favicon.png]
96 This Perl file will be loaded using 'do' and can be used to override any
97 of the options above as well as some other options -- see the "Runtime
98 gitweb configuration" section below, and top of 'gitweb.cgi' for their
99 full list and description. If the environment variable GITWEB_CONFIG
100 is set when gitweb.cgi is executed, then the file specified in the
101 environment variable will be loaded instead of the file specified
102 when gitweb.cgi was created. [Default: gitweb_config.perl]
103 * GITWEB_CONFIG_SYSTEM
104 This Perl file will be loaded using 'do' as a fallback if GITWEB_CONFIG
105 does not exist. If the environment variable GITWEB_CONFIG_SYSTEM is set
106 when gitweb.cgi is executed, then the file specified in the environment
107 variable will be loaded instead of the file specified when gitweb.cgi was
108 created. [Default: /etc/gitweb.conf]
111 Runtime gitweb configuration
112 ----------------------------
114 You can adjust gitweb behaviour using the file specified in `GITWEB_CONFIG`
115 (defaults to 'gitweb_config.perl' in the same directory as the CGI), and
116 as a fallback `GITWEB_CONFIG_SYSTEM` (defaults to /etc/gitweb.conf).
117 The most notable thing that is not configurable at compile time are the
118 optional features, stored in the '%features' variable.
120 Ultimate description on how to reconfigure the default features setting
121 in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
122 as comments inside 'gitweb.cgi'.
124 See also the "Gitweb config file" (with an example of config file), and
125 the "Gitweb repositories" sections in INSTALL file for gitweb.
128 The gitweb config file is a fragment of perl code. You can set variables
129 using "our $variable = value"; text from "#" character until the end
130 of a line is ignored. See perlsyn(1) man page for details.
132 Below is the list of variables which you might want to set in gitweb config.
133 See the top of 'gitweb.cgi' for the full list of variables and their
136 Gitweb config file variables
137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139 You can set, among others, the following variables in gitweb config files
140 (with the exception of $projectroot and $projects_list this list does
141 not include variables usually directly set during build):
143 Core git executable to use. By default set to "$GIT_BINDIR/git", which
144 in turn is by default set to "$(bindir)/git". If you use git from binary
145 package, set this to "/usr/bin/git". This can just be "git" if your
146 webserver has a sensible PATH. If you have multiple git versions
147 installed it can be used to choose which one to use.
149 Gitweb version, set automatically when creating gitweb.cgi from
150 gitweb.perl. You might want to modify it if you are running modified
153 Absolute filesystem path which will be prepended to project path;
154 the path to repository is $projectroot/$project. Set to
155 $GITWEB_PROJECTROOT during installation. This variable have to be
156 set correctly for gitweb to find repositories.
158 Source of projects list, either directory to scan, or text file
159 with list of repositories (in the "<URI-encoded repository path> SP
160 <URI-encoded repository owner>" line format; actually there can be
161 any sequence of whitespace in place of space (SP)). Set to
162 $GITWEB_LIST during installation. If empty, $projectroot is used
163 to scan for repositories.
165 Full URL and absolute URL of gitweb script;
166 in earlier versions of gitweb you might have need to set those
167 variables, now there should be no need to do it.
169 Base URL for relative URLs in pages generated by gitweb,
170 (e.g. $logo, $favicon, @stylesheets if they are relative URLs),
171 needed and used only for URLs with nonempty PATH_INFO via
172 <base href="$base_url>. Usually gitweb sets its value correctly,
173 and there is no need to set this variable, e.g. to $my_uri or "/".
175 Target of the home link on top of all pages (the first part of view
176 "breadcrumbs"). By default set to absolute URI of a page ($my_uri).
178 List of URIs of stylesheets (relative to base URI of a page). You
179 might specify more than one stylesheet, for example use gitweb.css
180 as base, with site specific modifications in separate stylesheet
181 to make it easier to upgrade gitweb. You can add 'site' stylesheet
183 push @stylesheets, "gitweb-site.css";
184 in the gitweb config file.
185 * $logo_url, $logo_label
186 URI and label (title) of GIT logo link (or your site logo, if you choose
187 to use different logo image). By default they point to git homepage;
188 in the past they pointed to git documentation at www.kernel.org.
189 * $projects_list_description_width
190 The width (in characters) of the projects list "Description" column.
191 Longer descriptions will be cut (trying to cut at word boundary);
192 full description is available as 'title' attribute (usually shown on
193 mouseover). By default set to 25, which might be too small if you
194 use long project descriptions.
196 List of git base URLs used for URL to where fetch project from, shown
197 in project summary page. Full URL is "$git_base_url/$project".
198 You can setup multiple base URLs (for example one for git:// protocol
199 access, and one for http:// "dumb" protocol access). Note that per
200 repository configuration in 'cloneurl' file, or as values of gitweb.url
202 * $default_blob_plain_mimetype
203 Default mimetype for blob_plain (raw) view, if mimetype checking
204 doesn't result in some other type; by default 'text/plain'.
205 * $default_text_plain_charset
206 Default charset for text files. If not set, web server configuration
209 File to use for (filename extension based) guessing of MIME types before
210 trying /etc/mime.types. Path, if relative, is taken currently as
211 relative to the current git repository.
213 Gitweb assumes this charset if line contains non-UTF-8 characters.
214 Fallback decoding is used without error checking, so it can be even
215 'utf-8'. Value must be valid encoding; see Encoding::Supported(3pm) man
216 page for a list. By default 'latin1', aka. 'iso-8859-1'.
218 Rename detection options for git-diff and git-diff-tree. By default
219 ('-M'); set it to ('-C') or ('-C', '-C') to also detect copies, or
220 set it to () if you don't want to have renames detection.
222 If true, some gitweb features are disabled to prevent content in
223 repositories from launching cross-site scripting (XSS) attacks. Set this
224 to true if you don't trust the content of your repositories. The default
226 * $frontpage_no_project_list
227 If 0, the gitweb frontpage will contain the project list; if 1 instead,
228 it will contain just the index text, search form, tag cloud (if enabled)
229 and a link to the actual project list. The page is reduced, but all
230 projects still need to be scanned for the tag cloud construction (but
231 the project info cache is used if enabled, of course). If the
232 option is set to 2, not even the tag cloud will be shown; this is fastest.
233 This option is useful for sites with large amount of projects. The default
236 Variables described below deal with caching in gitweb. If you don't
237 run gitweb installation on busy site with large number of repositories
238 (projects) you probably don't need caching; by default caching is
240 * $projlist_cache_lifetime
241 Lifetime of in-gitweb cache for projects list page, in minutes.
242 By default set to 0, which means tha projects list caching is
244 * $cache_dir, $projlist_cache_name
245 The cached list version (cache of Perl structure, not of final
246 output) is stored in "$cache_dir/$projlist_cache_name". $cache_dir
247 should be writable only by processes with the same uid as gitweb
248 (usually web served uid); if $cache_dir does not exist gitweb would
249 try to create it. Only single gitweb project root per system is
250 supported, unless gitweb instances for different projects root have
251 different configuration.
253 By default $cache_dir is set to "$TMPDIR/gitweb" if $TMPDIR
254 environment variable does exist, "/tmp/gitweb" otherwise.
255 Default name for $projlist_cache_name -s 'gitweb.index.cache';
257 NOTE: projects list cache file can be tweaked by other scripts
258 running with the same uid as gitweb; use this ONLY at secure
262 Projects list file format
263 ~~~~~~~~~~~~~~~~~~~~~~~~~
265 Instead of having gitweb find repositories by scanning filesystem starting
266 from $projectroot (or $projects_list, if it points to directory), you can
267 provide list of projects by setting $projects_list to a text file with list
268 of projects (and some additional info). This file uses the following
271 One record (for project / repository) per line, whitespace separated fields;
272 does not support (at least for now) lines continuation (newline escaping).
273 Leading and trailing whitespace are ignored, any run of whitespace can be
274 used as field separator (rules for Perl's "split(' ', $line)"). Keyed by
275 the first field, which is project name, i.e. path to repository GIT_DIR
276 relative to $projectroot. Fields use modified URI encoding, defined in
277 RFC 3986, section 2.1 (Percent-Encoding), or rather "Query string encoding"
278 (see http://en.wikipedia.org/wiki/Query_string#URL_encoding), the difference
279 being that SP (' ') can be encoded as '+' (and therefore '+' has to be also
280 percent-encoded). Reserved characters are: '%' (used for encoding), '+'
281 (can be used to encode SPACE), all whitespace characters as defined in Perl,
282 including SP, TAB and LF, (used to separate fields in a record).
284 Currently list of fields is
285 * <repository path> - path to repository GIT_DIR, relative to $projectroot
286 * <repository owner> - displayed as repository owner, preferably full name,
289 You can additionally use $projects_list file to limit which repositories
290 are visible, and together with $strict_export to limit access to
291 repositories (see "Gitweb repositories" section in gitweb/INSTALL).
294 Per-repository gitweb configuration
295 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
297 You can also configure individual repositories shown in gitweb by creating
298 file in the GIT_DIR of git repository, or by setting some repo configuration
299 variable (in GIT_DIR/config).
301 You can use the following files in repository:
303 A .html file (HTML fragment) which is included on the gitweb project
304 summary page inside <div> block element. You can use it for longer
305 description of a project, to provide links (for example to project's
306 homepage), etc. This is recognized only if XSS prevention is off
307 ($prevent_xss is false); a way to include a readme safely when XSS
308 prevention is on may be worked out in the future.
309 * description (or gitweb.description)
310 Short (shortened by default to 25 characters in the projects list page)
311 single line description of a project (of a repository). Plain text file;
312 HTML will be escaped. By default set to
313 Unnamed repository; edit this file to name it for gitweb.
314 from the template during repository creation. You can use the
315 gitweb.description repo configuration variable, but the file takes
317 * cloneurl (or multiple-valued gitweb.url)
318 File with repository URL (used for clone and fetch), one per line.
319 Displayed in the project summary page. You can use multiple-valued
320 gitweb.url repository configuration variable for that, but the file
323 You can use the gitweb.owner repository configuration variable to set
324 repository's owner. It is displayed in the project list and summary
325 page. If it's not set, filesystem directory's owner is used
326 (via GECOS field / real name field from getpwiud(3)).
327 * various gitweb.* config variables (in config)
328 Read description of %feature hash for detailed list, and some
332 Webserver configuration
333 -----------------------
335 If you want to have one URL for both gitweb and your http://
336 repositories, you can configure apache like this:
339 ServerName git.example.org
340 DocumentRoot /pub/git
341 SetEnv GITWEB_CONFIG /etc/gitweb.conf
343 # make the front page an internal rewrite to the gitweb script
344 RewriteRule ^/$ /cgi-bin/gitweb.cgi
345 # make access for "dumb clients" work
346 RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ /cgi-bin/gitweb.cgi%{REQUEST_URI} [L,PT]
349 The above configuration expects your public repositories to live under
350 /pub/git and will serve them as http://git.domain.org/dir-under-pub-git,
351 both as cloneable GIT URL and as browseable gitweb interface.
352 If you then start your git-daemon with --base-path=/pub/git --export-all
353 then you can even use the git:// URL with exactly the same path.
355 Setting the environment variable GITWEB_CONFIG will tell gitweb to use
356 the named file (i.e. in this example /etc/gitweb.conf) as a
357 configuration for gitweb. Perl variables defined in here will
358 override the defaults given at the head of the gitweb.perl (or
359 gitweb.cgi). Look at the comments in that file for information on
360 which variables and what they mean.
362 If you use the rewrite rules from the example you'll likely also need
363 something like the following in your gitweb.conf (or gitweb_config.perl) file:
365 @stylesheets = ("/some/absolute/path/gitweb.css");
371 -----------------------
372 If you enable PATH_INFO usage in gitweb by putting
374 $feature{'pathinfo'}{'default'} = [1];
376 in your gitweb.conf, it is possible to set up your server so that it
377 consumes and produces URLs in the form
379 http://git.example.com/project.git/shortlog/sometag
381 by using a configuration such as the following, that assumes that
382 /var/www/gitweb is the DocumentRoot of your webserver, and that it
383 contains the gitweb.cgi script and complementary static files
384 (stylesheet, favicon):
387 ServerAlias git.example.com
389 DocumentRoot /var/www/gitweb
391 <Directory /var/www/gitweb>
393 AddHandler cgi-script cgi
395 DirectoryIndex gitweb.cgi
398 RewriteCond %{REQUEST_FILENAME} !-f
399 RewriteCond %{REQUEST_FILENAME} !-d
400 RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
404 The rewrite rule guarantees that existing static files will be properly
405 served, whereas any other URL will be passed to gitweb as PATH_INFO
408 Notice that in this case you don't need special settings for
409 @stylesheets, $my_uri and $home_link, but you lose "dumb client" access
410 to your project .git dirs. A possible workaround for the latter is the
411 following: in your project root dir (e.g. /pub/git) have the projects
412 named without a .git extension (e.g. /pub/git/project instead of
413 /pub/git/project.git) and configure Apache as follows:
416 ServerAlias git.example.com
418 DocumentRoot /var/www/gitweb
420 AliasMatch ^(/.*?)(\.git)(/.*)?$ /pub/git$1$3
421 <Directory /var/www/gitweb>
423 AddHandler cgi-script cgi
425 DirectoryIndex gitweb.cgi
428 RewriteCond %{REQUEST_FILENAME} !-f
429 RewriteCond %{REQUEST_FILENAME} !-d
430 RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
434 The additional AliasMatch makes it so that
436 http://git.example.com/project.git
438 will give raw access to the project's git dir (so that the project can
441 http://git.example.com/project
443 will provide human-friendly gitweb access.
445 This solution is not 100% bulletproof, in the sense that if some project
446 has a named ref (branch, tag) starting with 'git/', then paths such as
448 http://git.example.com/project/command/abranch..git/abranch
450 will fail with a 404 error.
454 Originally written by:
455 Kay Sievers <kay.sievers@vrfy.org>
457 Any comment/question/concern to:
458 Git mailing list <git@vger.kernel.org>