Merge branch 'mh/notes-duplicate-entries'
[git/git.git] / gitweb / README
CommitLineData
0a8f4f00 1GIT web Interface
128eead1 2=================
0a8f4f00 3
175fb6c0 4From the git version 1.4.0 gitweb is bundled with git.
0a8f4f00 5
5d043a3d 6
07ea4df2
JN
7Build time gitweb configuration
8-------------------------------
9There are many configuration variables which affect building gitweb (among
10others creating gitweb.cgi out of gitweb.perl by replacing placeholders such
11as `++GIT_BINDIR++` by their build-time values).
12
13Building and installing gitweb is described in gitweb's INSTALL file
14(in 'gitweb/INSTALL').
15
16
45a3b12c
PB
17Runtime gitweb configuration
18----------------------------
131d6afc
JN
19Gitweb obtains configuration data from the following sources in the
20following order:
21
221. built-in values (some set during build stage),
232. common system-wide configuration file (`GITWEB_CONFIG_COMMON`,
24 defaults to '/etc/gitweb-common.conf'),
253. either per-instance configuration file (`GITWEB_CONFIG`, defaults to
26 'gitweb_config.perl' in the same directory as the installed gitweb),
27 or if it does not exists then system-wide configuration file
28 (`GITWEB_CONFIG_SYSTEM`, defaults to '/etc/gitweb.conf').
29
30Values obtained in later configuration files override values obtained earlier
31in above sequence.
32
33You can read defaults in system-wide GITWEB_CONFIG_SYSTEM from GITWEB_CONFIG
34by adding
35
36 read_config_file($GITWEB_CONFIG_SYSTEM);
37
38at very beginning of per-instance GITWEB_CONFIG file. In this case
39settings in said per-instance file will override settings from
40system-wide configuration file. Note that read_config_file checks
41itself that the $GITWEB_CONFIG_SYSTEM file exists.
42
45a3b12c 43The most notable thing that is not configurable at compile time are the
61fd2552
JN
44optional features, stored in the '%features' variable.
45
46Ultimate description on how to reconfigure the default features setting
47in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
48as comments inside 'gitweb.cgi'.
49
6d3902b0 50See also gitweb.conf(5) manpage.
61fd2552
JN
51
52
07ea4df2
JN
53Web server configuration
54------------------------
55Gitweb can be run as CGI script, as legacy mod_perl application (using
56ModPerl::Registry), and as FastCGI script. You can find some simple examples
57in "Example web server configuration" section in INSTALL file for gitweb (in
58gitweb/INSTALL).
1bed73c6 59
07ea4df2
JN
60See "Webserver configuration" and "Advanced web server setup" sections in
61gitweb(1) manpage.
1bed73c6 62
0dbf027a 63
07ea4df2
JN
64AUTHORS
65-------
ee0d3234 66Originally written by:
0a8f4f00 67 Kay Sievers <kay.sievers@vrfy.org>
ee0d3234
JH
68
69Any comment/question/concern to:
70 Git mailing list <git@vger.kernel.org>