Merge branch 'mv/defer-gc'
[git] / gitweb / INSTALL
1 GIT web Interface (gitweb) Installation
2 =======================================
3
4 First you have to generate gitweb.cgi from gitweb.perl using
5 "make gitweb/gitweb.cgi", then copy appropriate files (gitweb.cgi,
6 gitweb.css, git-logo.png and git-favicon.png) to their destination.
7 For example if git was (or is) installed with /usr prefix, you can do
8
9         $ make prefix=/usr gitweb/gitweb.cgi  ;# as yourself
10         # cp gitweb/git* /var/www/cgi-bin/    ;# as root
11
12 Alternatively you can use autoconf generated ./configure script to
13 set up path to git binaries (via config.mak.autogen), so you can write
14 instead
15
16         $ make configure                     ;# as yourself
17         $ ./configure --prefix=/usr          ;# as yourself
18         $ make gitweb/gitweb.cgi             ;# as yourself
19         # cp gitweb/git* /var/www/cgi-bin/   ;# as root
20
21 The above example assumes that your web server is configured to run
22 [executable] files in /var/www/cgi-bin/ as server scripts (as CGI
23 scripts).
24
25
26 Build time configuration
27 ------------------------
28
29 See also "How to configure gitweb for your local system" in README
30 file for gitweb (in gitweb/README).
31
32 - There are many configuration variables which affects building of
33   gitweb.cgi; see "default configuration for gitweb" section in main
34   (top dir) Makefile, and instructions for building gitweb/gitweb.cgi
35   target.
36
37   One of most important is where to find git wrapper binary. Gitweb
38   tries to find git wrapper at $(bindir)/git, so you have to set $bindir
39   when building gitweb.cgi, or $prefix from which $bindir is derived. If
40   you build and install gitweb together with the rest of git suite,
41   there should be no problems. Otherwise, if git was for example
42   installed from a binary package, you have to set $prefix (or $bindir)
43   accordingly.
44
45 - Another important issue is where are git repositories you want to make
46   available to gitweb. By default gitweb search for repositories under
47   /pub/git; if you want to have projects somewhere else, like /home/git,
48   use GITWEB_PROJECTROOT build configuration variable.
49
50   By default all git repositories under projectroot are visible and
51   available to gitweb. List of projects is generated by default by
52   scanning the projectroot directory for git repositories. This can be
53   changed (configured) as described in "Gitweb repositories" section
54   below.
55
56   Note that gitweb deals directly with object database, and does not
57   need working directory; the name of the project is the name of its
58   repository object database, usually projectname.git for bare
59   repositories. If you want to provide gitweb access to non-bare (live)
60   repository, you can make projectname.git symbolic link under
61   projectroot linking to projectname/.git (but it is just
62   a suggestion).
63
64 - You can control where gitweb tries to find its main CSS style file,
65   its favicon and logo with GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
66   build configuration variables. By default gitweb tries to find them
67   in the same directory as gitweb.cgi script.
68
69 Build example
70 ~~~~~~~~~~~~~
71
72 - To install gitweb to /var/www/cgi-bin/gitweb/ when git wrapper
73   is installed at /usr/local/bin/git and the repositories (projects)
74   we want to display are under /home/local/scm, you can do
75
76         make GITWEB_PROJECTROOT="/home/local/scm" \
77              GITWEB_CSS="/gitweb/gitweb.css" \
78              GITWEB_LOGO="/gitweb/git-logo.png" \
79              GITWEB_FAVICON="/gitweb/git-favicon.png" \
80              bindir=/usr/local/bin \
81              gitweb/gitweb.cgi
82
83         cp -fv ~/git/gitweb/gitweb.{cgi,css} \
84                ~/git/gitweb/git-{favicon,logo}.png \
85              /var/www/cgi-bin/gitweb/
86
87
88 Gitweb config file
89 ------------------
90
91 See also "Runtime gitweb configuration" section in README file
92 for gitweb (in gitweb/README).
93
94 - You can configure gitweb further using gitweb configuration file;
95   by default it is file named gitweb_config.perl in the same place as
96   gitweb.cgi script. You can control default place for config file
97   using GITWEB_CONFIG build configuration variable, and you can set it
98   using GITWEB_CONFIG environmental variable. If this file does not
99   exist, gitweb looks for a system-wide configuration file, normally
100   /etc/gitweb.conf. You can change the default using the
101   GITWEB_CONFIG_SYSTEM build configuration variable, and override it
102   through GITWEB_CONFIG_SYSTEM environmental variable.
103
104 - Gitweb config file is [fragment] of perl code. You can set variables
105   using "our $variable = value"; text from "#" character until the end
106   of a line is ignored. See perlsyn(1) for details.
107
108   See the top of gitweb.perl file for examples of customizable options.
109
110 Config file example
111 ~~~~~~~~~~~~~~~~~~~
112
113 To enable blame, pickaxe search, and snapshot support, while allowing
114 individual projects to turn them off, put the following in your
115 GITWEB_CONFIG file:
116
117         $feature{'blame'}{'default'} = [1];
118         $feature{'blame'}{'override'} = 1;
119
120         $feature{'pickaxe'}{'default'} = [1];
121         $feature{'pickaxe'}{'override'} = 1;
122
123         $feature{'snapshot'}{'default'} = ['zip', 'tgz'];
124         $feature{'snapshot'}{'override'} = 1;
125
126
127 Gitweb repositories
128 -------------------
129
130 - By default all git repositories under projectroot are visible and
131   available to gitweb. List of projects is generated by default by
132   scanning the projectroot directory for git repositories (for object
133   databases to be more exact).
134
135   You can provide pre-generated list of [visible] repositories,
136   together with information about their owners (the project ownership
137   is taken from owner of repository directory otherwise), by setting
138   GITWEB_LIST build configuration variable (or $projects_list variable
139   in gitweb config file) to point to a plain file.
140
141   Each line of projects list file should consist of url-encoded path
142   to project repository database (relative to projectroot) separated
143   by space from url-encoded project owner; spaces in both project path
144   and project owner have to be encoded as either '%20' or '+'.
145
146   You can generate projects list index file using project_index action
147   (the 'TXT' link on projects list page) directly from gitweb.
148
149 - By default even if project is not visible on projects list page, you
150   can view it nevertheless by hand-crafting gitweb URL. You can set
151   GITWEB_STRICT_EXPORT build configuration variable (or $strict_export
152   variable in gitweb config file) to only allow viewing of
153   repositories also shown on the overview page.
154
155 - Alternatively, you can configure gitweb to only list and allow
156   viewing of the explicitly exported repositories, via
157   GITWEB_EXPORT_OK build configuration variable (or $export_ok
158   variable in gitweb config file). If it evaluates to true, gitweb
159   show repository only if this file exists in its object database
160   (if directory has the magic file $export_ok).
161
162 Generating projects list using gitweb
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164
165 We assume that GITWEB_CONFIG has its default Makefile value, namely
166 gitweb_config.perl. Put the following in gitweb_make_index.perl file:
167
168         $GITWEB_CONFIG = "gitweb_config.perl";
169         do $GITWEB_CONFIG if -e $GITWEB_CONFIG;
170
171         $projects_list = $projectroot;
172
173 Then create the following script to get list of project in the format
174 suitable for GITWEB_LIST build configuration variable (or
175 $projects_list variable in gitweb config):
176
177         #!/bin/sh
178
179         export GITWEB_CONFIG="gitweb_make_index.perl"
180         export GATEWAY_INTERFACE="CGI/1.1"
181         export HTTP_ACCEPT="*/*"
182         export REQUEST_METHOD="GET"
183         export QUERY_STRING="a=project_index"
184
185         perl -- /var/www/cgi-bin/gitweb.cgi
186
187
188 Requirements
189 ------------
190
191  - Core git tools
192  - Perl
193  - Perl modules: CGI, Encode, Fcntl, File::Find, File::Basename.
194  - web server
195
196
197 Example web server configuration
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199
200 See also "Webserver configuration" section in README file for gitweb
201 (in gitweb/README).
202
203
204 - Apache2, gitweb installed as CGI script,
205   under /var/www/cgi-bin/
206
207         ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"
208
209         <Directory "/var/www/cgi-bin">
210             Options Indexes FollowSymlinks ExecCGI
211             AllowOverride None
212             Order allow,deny
213             Allow from all
214         </Directory>
215
216 - Apache2, gitweb installed as mod_perl legacy script,
217   under /var/www/perl/
218
219         Alias /perl "/var/www/perl"
220
221         <Directory "/var/www/perl">
222             SetHandler perl-script
223             PerlResponseHandler ModPerl::Registry
224             PerlOptions +ParseHeaders
225             Options Indexes FollowSymlinks +ExecCGI
226             AllowOverride None
227             Order allow,deny
228             Allow from all
229         </Directory>