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