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