gitweb/README

   1 GIT web Interface
   2
   3 The one working on:
   4   http://www.kernel.org/git/
   5
   6 From the git version 1.4.0 gitweb is bundled with git.
   7
   8
   9 How to configure gitweb for your local system:
  10
  11 You can specify the following configuration variables when building GIT:
  12  * GITWEB_SITENAME
  13    Shown in the title of all generated pages, defaults to the servers name.
  14  * GITWEB_PROJECTROOT
  15    The root directory for all projects shown by gitweb.
  16  * GITWEB_LIST
  17    points to a directory to scan for projects (defaults to project root)
  18    or to a file for explicit listing of projects.
  19  * GITWEB_HOMETEXT
  20    points to an .html file which is included on the gitweb project
  21    overview page.
  22  * GITWEB_CSS
  23    Points to the location where you put gitweb.css on your web server.
  24  * GITWEB_LOGO
  25    Points to the location where you put git-logo.png on your web server.
  26  * GITWEB_CONFIG
  27    This file will be loaded using 'require' and can be used to override any
  28    of the options above as well as some other options - see the top of
  29    'gitweb.cgi' for their full list and description.  If the environment
  30    $GITWEB_CONFIG is set when gitweb.cgi is executed the file in the
  31    environment variable will be loaded instead of the file
  32    specified when gitweb.cgi was created.
  33
  34 Runtime gitweb configuration
  35 ----------------------------
  36
  37 You can adjust gitweb behaviour using the file specified in `GITWEB_CONFIG`
  38 (defaults to 'gitweb_config.perl' in the same directory as the CGI).
  39 See the top of 'gitweb.cgi' for the list of variables and some description.
  40 The most notable thing that is not configurable at compile time are the
  41 optional features, stored in the '%features' variable. You can find further
  42 description on how to reconfigure the default features setting in your
  43 `GITWEB_CONFIG` or per-project in `project.git/config` inside 'gitweb.cgi'.
  44
  45
  46 Originally written by:
  47   Kay Sievers <kay.sievers@vrfy.org>
  48
  49 Any comment/question/concern to:
  50   Git mailing list <git@vger.kernel.org>
  51