Thread-safe xmalloc and xrealloc needs a recursive mutex
[git/dscho.git] / gitweb / README
1 GIT web Interface
2 =================
4 The one working on:
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]
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]
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]
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>.
64    [Default: projects]
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    Points to the localtion where you put gitweb.js on your web server
97    (or to be more generic URI of JavaScript code used by gitweb).
98    Relative to base URI of gitweb.  [Default: gitweb.js (or gitweb.min.js
99    if JSMIN build variable is defined / JavaScript minifier is used)]
101    This Perl file will be loaded using 'do' and can be used to override any
102    of the options above as well as some other options -- see the "Runtime
103    gitweb configuration" section below, and top of 'gitweb.cgi' for their
104    full list and description.  If the environment variable GITWEB_CONFIG
105    is set when gitweb.cgi is executed, then the file specified in the
106    environment variable will be loaded instead of the file specified
107    when gitweb.cgi was created.  [Default: gitweb_config.perl]
109    This Perl file will be loaded using 'do' as a fallback if GITWEB_CONFIG
110    does not exist.  If the environment variable GITWEB_CONFIG_SYSTEM is set
111    when gitweb.cgi is executed, then the file specified in the environment
112    variable will be loaded instead of the file specified when gitweb.cgi was
113    created.  [Default: /etc/gitweb.conf]
116 Runtime gitweb configuration
117 ----------------------------
119 You can adjust gitweb behaviour using the file specified in `GITWEB_CONFIG`
120 (defaults to 'gitweb_config.perl' in the same directory as the CGI), and
121 as a fallback `GITWEB_CONFIG_SYSTEM` (defaults to /etc/gitweb.conf).
122 The most notable thing that is not configurable at compile time are the
123 optional features, stored in the '%features' variable.
125 Ultimate description on how to reconfigure the default features setting
126 in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
127 as comments inside 'gitweb.cgi'.
129 See also the "Gitweb config file" (with an example of config file), and
130 the "Gitweb repositories" sections in INSTALL file for gitweb.
133 The gitweb config file is a fragment of perl code. You can set variables
134 using "our $variable = value"; text from "#" character until the end
135 of a line is ignored. See perlsyn(1) man page for details.
137 Below is the list of variables which you might want to set in gitweb config.
138 See the top of 'gitweb.cgi' for the full list of variables and their
139 descriptions.
141 Gitweb config file variables
142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144 You can set, among others, the following variables in gitweb config files
145 (with the exception of $projectroot and $projects_list this list does
146 not include variables usually directly set during build):
147  * $GIT
148    Core git executable to use.  By default set to "$GIT_BINDIR/git", which
149    in turn is by default set to "$(bindir)/git".  If you use git from binary
150    package, set this to "/usr/bin/git".  This can just be "git" if your
151    webserver has a sensible PATH.  If you have multiple git versions
152    installed it can be used to choose which one to use.
153  * $version
154    Gitweb version, set automatically when creating gitweb.cgi from
155    gitweb.perl. You might want to modify it if you are running modified
156    gitweb.
157  * $projectroot
158    Absolute filesystem path which will be prepended to project path;
159    the path to repository is $projectroot/$project.  Set to
160    $GITWEB_PROJECTROOT during installation.  This variable have to be
161    set correctly for gitweb to find repositories.
162  * $projects_list
163    Source of projects list, either directory to scan, or text file
164    with list of repositories (in the "<URI-encoded repository path> SP
165    <URI-encoded repository owner>" line format; actually there can be
166    any sequence of whitespace in place of space (SP)).  Set to
167    $GITWEB_LIST during installation.  If empty, $projectroot is used
168    to scan for repositories.
169  * $my_url, $my_uri
170    Full URL and absolute URL of gitweb script;
171    in earlier versions of gitweb you might have need to set those
172    variables, now there should be no need to do it.
173  * $base_url
174    Base URL for relative URLs in pages generated by gitweb,
175    (e.g. $logo, $favicon, @stylesheets if they are relative URLs),
176    needed and used only for URLs with nonempty PATH_INFO via
177    <base href="$base_url">.  Usually gitweb sets its value correctly,
178    and there is no need to set this variable, e.g. to $my_uri or "/".
179  * $home_link
180    Target of the home link on top of all pages (the first part of view
181    "breadcrumbs").  By default set to absolute URI of a page ($my_uri).
182  * @stylesheets
183    List of URIs of stylesheets (relative to base URI of a page). You
184    might specify more than one stylesheet, for example use gitweb.css
185    as base, with site specific modifications in separate stylesheet
186    to make it easier to upgrade gitweb. You can add 'site' stylesheet
187    for example by using
188       push @stylesheets, "gitweb-site.css";
189    in the gitweb config file.
190  * $logo_url, $logo_label
191    URI and label (title) of GIT logo link (or your site logo, if you choose
192    to use different logo image). By default they point to git homepage;
193    in the past they pointed to git documentation at
194  * $projects_list_description_width
195    The width (in characters) of the projects list "Description" column.
196    Longer descriptions will be cut (trying to cut at word boundary);
197    full description is available as 'title' attribute (usually shown on
198    mouseover).  By default set to 25, which might be too small if you
199    use long project descriptions.
200  * @git_base_url_list
201    List of git base URLs used for URL to where fetch project from, shown
202    in project summary page.  Full URL is "$git_base_url/$project".
203    You can setup multiple base URLs (for example one for  git:// protocol
204    access, and one for http:// "dumb" protocol access).  Note that per
205    repository configuration in 'cloneurl' file, or as values of gitweb.url
206    project config.
207  * $default_blob_plain_mimetype
208    Default mimetype for blob_plain (raw) view, if mimetype checking
209    doesn't result in some other type; by default 'text/plain'.
210  * $default_text_plain_charset
211    Default charset for text files. If not set, web server configuration
212    would be used.
213  * $mimetypes_file
214    File to use for (filename extension based) guessing of MIME types before
215    trying /etc/mime.types. Path, if relative, is taken currently as
216    relative to the current git repository.
217  * $fallback_encoding
218    Gitweb assumes this charset if line contains non-UTF-8 characters.
219    Fallback decoding is used without error checking, so it can be even
220    'utf-8'. Value must be valid encoding; see Encoding::Supported(3pm) man
221    page for a list.   By default 'latin1', aka. 'iso-8859-1'.
222  * @diff_opts
223    Rename detection options for git-diff and git-diff-tree. By default
224    ('-M'); set it to ('-C') or ('-C', '-C') to also detect copies, or
225    set it to () if you don't want to have renames detection.
226  * $prevent_xss
227    If true, some gitweb features are disabled to prevent content in
228    repositories from launching cross-site scripting (XSS) attacks.  Set this
229    to true if you don't trust the content of your repositories. The default
230    is false.
231  * $maxload
232    Used to set the maximum load that we will still respond to gitweb queries.
233    If server load exceed this value then return "503 Service Unavaliable" error.
234    Server load is taken to be 0 if gitweb cannot determine its value.  Set it to
235    undefined value to turn it off.  The default is 300.
238 Projects list file format
239 ~~~~~~~~~~~~~~~~~~~~~~~~~
241 Instead of having gitweb find repositories by scanning filesystem starting
242 from $projectroot (or $projects_list, if it points to directory), you can
243 provide list of projects by setting $projects_list to a text file with list
244 of projects (and some additional info).  This file uses the following
245 format:
247 One record (for project / repository) per line, whitespace separated fields;
248 does not support (at least for now) lines continuation (newline escaping).
249 Leading and trailing whitespace are ignored, any run of whitespace can be
250 used as field separator (rules for Perl's "split(' ', $line)").  Keyed by
251 the first field, which is project name, i.e. path to repository GIT_DIR
252 relative to $projectroot.  Fields use modified URI encoding, defined in
253 RFC 3986, section 2.1 (Percent-Encoding), or rather "Query string encoding"
254 (see, the difference
255 being that SP (' ') can be encoded as '+' (and therefore '+' has to be also
256 percent-encoded).  Reserved characters are: '%' (used for encoding), '+'
257 (can be used to encode SPACE), all whitespace characters as defined in Perl,
258 including SP, TAB and LF, (used to separate fields in a record).
260 Currently list of fields is
261  * <repository path>  - path to repository GIT_DIR, relative to $projectroot
262  * <repository owner> - displayed as repository owner, preferably full name,
263                         or email, or both
265 You can additionally use $projects_list file to limit which repositories
266 are visible, and together with $strict_export to limit access to
267 repositories (see "Gitweb repositories" section in gitweb/INSTALL).
270 Per-repository gitweb configuration
271 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
273 You can also configure individual repositories shown in gitweb by creating
274 file in the GIT_DIR of git repository, or by setting some repo configuration
275 variable (in GIT_DIR/config).
277 You can use the following files in repository:
278  * README.html
279    A .html file (HTML fragment) which is included on the gitweb project
280    summary page inside <div> block element. You can use it for longer
281    description of a project, to provide links (for example to project's
282    homepage), etc. This is recognized only if XSS prevention is off
283    ($prevent_xss is false); a way to include a readme safely when XSS
284    prevention is on may be worked out in the future.
285  * description (or gitweb.description)
286    Short (shortened by default to 25 characters in the projects list page)
287    single line description of a project (of a repository). Plain text file;
288    HTML will be escaped. By default set to
289      Unnamed repository; edit this file to name it for gitweb.
290    from the template during repository creation. You can use the
291    gitweb.description repo configuration variable, but the file takes
292    precedence.
293  * cloneurl (or multiple-valued gitweb.url)
294    File with repository URL (used for clone and fetch), one per line.
295    Displayed in the project summary page. You can use multiple-valued
296    gitweb.url repository configuration variable for that, but the file
297    takes precedence.
298  * gitweb.owner
299    You can use the gitweb.owner repository configuration variable to set
300    repository's owner. It is displayed in the project list and summary
301    page. If it's not set, filesystem directory's owner is used
302    (via GECOS field / real name field from getpwiud(3)).
303  * various gitweb.* config variables (in config)
304    Read description of %feature hash for detailed list, and some
305    descriptions.
308 Webserver configuration
309 -----------------------
311 If you want to have one URL for both gitweb and your http://
312 repositories, you can configure apache like this:
314 <VirtualHost *:80>
315     ServerName
316     DocumentRoot        /pub/git
317     SetEnv                      GITWEB_CONFIG   /etc/gitweb.conf
319     # turning on mod rewrite
320     RewriteEngine on
322     # make the front page an internal rewrite to the gitweb script
323     RewriteRule ^/$  /cgi-bin/gitweb.cgi
325     # make access for "dumb clients" work
326     RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ /cgi-bin/gitweb.cgi%{REQUEST_URI}  [L,PT]
327 </VirtualHost>
329 The above configuration expects your public repositories to live under
330 /pub/git and will serve them as,
331 both as cloneable GIT URL and as browseable gitweb interface.
332 If you then start your git-daemon with --base-path=/pub/git --export-all
333 then you can even use the git:// URL with exactly the same path.
335 Setting the environment variable GITWEB_CONFIG will tell gitweb to use
336 the named file (i.e. in this example /etc/gitweb.conf) as a
337 configuration for gitweb.  Perl variables defined in here will
338 override the defaults given at the head of the gitweb.perl (or
339 gitweb.cgi).  Look at the comments in that file for information on
340 which variables and what they mean.
342 If you use the rewrite rules from the example you'll likely also need
343 something like the following in your gitweb.conf (or gitweb_config.perl) file:
345   @stylesheets = ("/some/absolute/path/gitweb.css");
346   $my_uri = "/";
347   $home_link = "/";
350 Webserver configuration with multiple projects' root
351 ----------------------------------------------------
353 If you want to use gitweb with several project roots you can edit your apache
354 virtual host and gitweb.conf configuration files like this :
356 virtual host configuration :
358 <VirtualHost *:80>
359     ServerName        
360     DocumentRoot                /pub/git
361     SetEnv                              GITWEB_CONFIG   /etc/gitweb.conf
363     # turning on mod rewrite
364     RewriteEngine on
366     # make the front page an internal rewrite to the gitweb script
367     RewriteRule ^/$             /cgi-bin/gitweb.cgi [QSA,L,PT]
369     # look for a public_git folder in unix users' home
370     #<user>/
371     RewriteRule ^/\~([^\/]+)(/|/gitweb.cgi)?$   /cgi-bin/gitweb.cgi [QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
373     #<user>/
374     #RewriteRule ^/\+([^\/]+)(/|/gitweb.cgi)?$  /cgi-bin/gitweb.cgi [QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
376     #<user>/
377     #RewriteRule ^/user/([^\/]+)/(gitweb.cgi)?$ /cgi-bin/gitweb.cgi [QSA,E=GITWEB_PROJECTROOT:/home/$1/public_git/,L,PT]
379     # defined list of project roots
380     RewriteRule ^/scm(/|/gitweb.cgi)?$          /cgi-bin/gitweb.cgi [QSA,E=GITWEB_PROJECTROOT:/pub/scm/,L,PT]
381     RewriteRule ^/var(/|/gitweb.cgi)?$          /cgi-bin/gitweb.cgi [QSA,E=GITWEB_PROJECTROOT:/var/git/,L,PT]
383     # make access for "dumb clients" work
384     RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ /cgi-bin/gitweb.cgi%{REQUEST_URI}  [L,PT]
385 </VirtualHost>
387 gitweb.conf configuration :
389 $projectroot = $ENV{'GITWEB_PROJECTROOT'} || "/pub/git";
391 These configurations enable two things. First, each unix user (<user>) of the
392 server will be able to browse through gitweb git repositories found in
393 ~/public_git/ with the following url :<user>/
395 If you do not want this feature on your server just remove the second rewrite rule.
397 If you already use mod_userdir in your virtual host or you don't want to use
398 the '~' as first character just comment or remove the second rewrite rule and
399 uncomment one of the following according to what you want.
401 Second, repositories found in /pub/scm/ and /var/git/ will be accesible
402 through and
403 You can add as many project roots as you want by adding rewrite rules like the
404 third and the fourth.
407 PATH_INFO usage
408 -----------------------
409 If you enable PATH_INFO usage in gitweb by putting
411    $feature{'pathinfo'}{'default'} = [1];
413 in your gitweb.conf, it is possible to set up your server so that it
414 consumes and produces URLs in the form
418 by using a configuration such as the following, that assumes that
419 /var/www/gitweb is the DocumentRoot of your webserver, and that it
420 contains the gitweb.cgi script and complementary static files
421 (stylesheet, favicon):
423 <VirtualHost *:80>
424         ServerAlias
426         DocumentRoot /var/www/gitweb
428         <Directory /var/www/gitweb>
429                 Options ExecCGI
430                 AddHandler cgi-script cgi
432                 DirectoryIndex gitweb.cgi
434                 RewriteEngine On
435                 RewriteCond %{REQUEST_FILENAME} !-f
436                 RewriteCond %{REQUEST_FILENAME} !-d
437                 RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
438         </Directory>
439 </VirtualHost>
441 The rewrite rule guarantees that existing static files will be properly
442 served, whereas any other URL will be passed to gitweb as PATH_INFO
443 parameter.
445 Notice that in this case you don't need special settings for
446 @stylesheets, $my_uri and $home_link, but you lose "dumb client" access
447 to your project .git dirs. A possible workaround for the latter is the
448 following: in your project root dir (e.g. /pub/git) have the projects
449 named without a .git extension (e.g. /pub/git/project instead of
450 /pub/git/project.git) and configure Apache as follows:
452 <VirtualHost *:80>
453         ServerAlias
455         DocumentRoot /var/www/gitweb
457         AliasMatch ^(/.*?)(\.git)(/.*)?$ /pub/git$1$3
458         <Directory /var/www/gitweb>
459                 Options ExecCGI
460                 AddHandler cgi-script cgi
462                 DirectoryIndex gitweb.cgi
464                 RewriteEngine On
465                 RewriteCond %{REQUEST_FILENAME} !-f
466                 RewriteCond %{REQUEST_FILENAME} !-d
467                 RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
468         </Directory>
469 </VirtualHost>
471 The additional AliasMatch makes it so that
475 will give raw access to the project's git dir (so that the project can
476 be cloned), while
480 will provide human-friendly gitweb access.
482 This solution is not 100% bulletproof, in the sense that if some project
483 has a named ref (branch, tag) starting with 'git/', then paths such as
487 will fail with a 404 error.
491 Originally written by:
492   Kay Sievers <>
494 Any comment/question/concern to:
495   Git mailing list <>