Fourth batch for 2.5 cycle
[git.git] / gitweb / README
Commit [+]AuthorDateLineData
0a8f4f00 Junio C Hamano2006-06-10 11:20:59 -07001GIT web Interface
128eead1 Martin Waitz2006-10-03 10:03:28 +02002=================
0a8f4f00 Junio C Hamano2006-06-10 11:20:59 -07003
175fb6c0 Jakub Narębski2006-06-17 08:53:45 +02004From the git version 1.4.0 gitweb is bundled with git.
0a8f4f00 Junio C Hamano2006-06-10 11:20:59 -07005
5d043a3d Martin Waitz2006-08-01 21:34:08 +02006
07ea4df2
JN
Jakub Narębski2011-10-16 13:07:32 +02007Build 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
Petr Baudis2006-10-07 15:17:47 +020017Runtime gitweb configuration
18----------------------------
131d6afc
JN
Jakub Narębski2011-07-25 00:29:18 +020019Gitweb 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 Petr Baudis2006-10-07 15:17:47 +020043The most notable thing that is not configurable at compile time are the
61fd2552
JN
Jakub Narębski2007-12-03 00:22:02 +010044optional 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 Drew Northup2011-10-16 13:07:31 +020050See also gitweb.conf(5) manpage.
61fd2552
JN
Jakub Narębski2007-12-03 00:22:02 +010051
52
07ea4df2
JN
Jakub Narębski2011-10-16 13:07:32 +020053Web 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 Giuseppe Bilotta2009-06-27 18:24:11 +020059
07ea4df2
JN
Jakub Narębski2011-10-16 13:07:32 +020060See "Webserver configuration" and "Advanced web server setup" sections in
61gitweb(1) manpage.
1bed73c6 Giuseppe Bilotta2009-06-27 18:24:11 +020062
0dbf027a Giuseppe Bilotta2009-01-31 02:31:51 +010063
07ea4df2
JN
Jakub Narębski2011-10-16 13:07:32 +020064AUTHORS
65-------
ee0d3234 Junio C Hamano2006-08-01 15:56:28 -070066Originally written by:
0a8f4f00 Junio C Hamano2006-06-10 11:20:59 -070067 Kay Sievers <kay.sievers@vrfy.org>
ee0d3234
JH
Junio C Hamano2006-08-01 15:56:28 -070068
69Any comment/question/concern to:
70 Git mailing list <git@vger.kernel.org>