gitweb / READMEon commit Merge branch 'mh/ref-api' (ec04a27)
   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
  10Build time gitweb configuration
  11-------------------------------
  12There are many configuration variables which affect building gitweb (among
  13others creating gitweb.cgi out of gitweb.perl by replacing placeholders such
  14as `++GIT_BINDIR++` by their build-time values).
  15
  16Building and installing gitweb is described in gitweb's INSTALL file
  17(in 'gitweb/INSTALL').
  18
  19
  20Runtime gitweb configuration
  21----------------------------
  22Gitweb obtains configuration data from the following sources in the
  23following order:
  24
  251. built-in values (some set during build stage),
  262. common system-wide configuration file (`GITWEB_CONFIG_COMMON`,
  27   defaults to '/etc/gitweb-common.conf'),
  283. either per-instance configuration file (`GITWEB_CONFIG`, defaults to
  29   'gitweb_config.perl' in the same directory as the installed gitweb),
  30   or if it does not exists then system-wide configuration file
  31   (`GITWEB_CONFIG_SYSTEM`, defaults to '/etc/gitweb.conf').
  32
  33Values obtained in later configuration files override values obtained earlier
  34in above sequence.
  35
  36You can read defaults in system-wide GITWEB_CONFIG_SYSTEM from GITWEB_CONFIG
  37by adding
  38
  39  read_config_file($GITWEB_CONFIG_SYSTEM);
  40
  41at very beginning of per-instance GITWEB_CONFIG file.  In this case
  42settings in said per-instance file will override settings from
  43system-wide configuration file.  Note that read_config_file checks
  44itself that the $GITWEB_CONFIG_SYSTEM file exists.
  45
  46The most notable thing that is not configurable at compile time are the
  47optional features, stored in the '%features' variable.
  48
  49Ultimate description on how to reconfigure the default features setting
  50in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
  51as comments inside 'gitweb.cgi'.
  52
  53See also gitweb.conf(5) manpage.
  54
  55
  56Web server configuration
  57------------------------
  58Gitweb can be run as CGI script, as legacy mod_perl application (using
  59ModPerl::Registry), and as FastCGI script.  You can find some simple examples
  60in "Example web server configuration" section in INSTALL file for gitweb (in
  61gitweb/INSTALL).
  62
  63See "Webserver configuration" and "Advanced web server setup" sections in
  64gitweb(1) manpage.
  65
  66
  67AUTHORS
  68-------
  69Originally written by:
  70  Kay Sievers <kay.sievers@vrfy.org>
  71
  72Any comment/question/concern to:
  73  Git mailing list <git@vger.kernel.org>