gitweb: use new Git::Repo API, and add optional caching
[git/gitweb-caching.git] / gitweb / INSTALL
blobc4ab593b5f06323ff575a7b6f9d3d8ba14050afd
1 GIT web Interface (gitweb) Installation
2 =======================================
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
9         $ make prefix=/usr gitweb/gitweb.cgi           ;# as yourself
10         # cp gitweb/git* /var/www/cgi-bin/             ;# as root
12 If the Git Perl package isn't already installed system-wide, you also
13 need to copy the perl/blib/lib/Git directory to your cgi-bin
14 directory:
16         $ make prefix=/usr -C perl                     ;# as yourself
17         # cp -r perl/blib/lib/Git /var/www/cgi-bin/    ;# as root
19 Alternatively you can use autoconf generated ./configure script to
20 set up path to git binaries (via config.mak.autogen), so you can write
21 instead
23         $ make configure                     ;# as yourself
24         $ ./configure --prefix=/usr          ;# as yourself
25         $ make gitweb/gitweb.cgi             ;# as yourself
26         # cp gitweb/git* /var/www/cgi-bin/   ;# as root
28 The above example assumes that your web server is configured to run
29 [executable] files in /var/www/cgi-bin/ as server scripts (as CGI
30 scripts).
33 Build time configuration
34 ------------------------
36 See also "How to configure gitweb for your local system" in README
37 file for gitweb (in gitweb/README).
39 - There are many configuration variables which affect building of
40   gitweb.cgi; see "default configuration for gitweb" section in main
41   (top dir) Makefile, and instructions for building gitweb/gitweb.cgi
42   target.
44   One of the most important is where to find the git wrapper binary. Gitweb
45   tries to find the git wrapper at $(bindir)/git, so you have to set $bindir
46   when building gitweb.cgi, or $prefix from which $bindir is derived. If
47   you build and install gitweb together with the rest of the git suite,
48   there should be no problems. Otherwise, if git was for example
49   installed from a binary package, you have to set $prefix (or $bindir)
50   accordingly.
52 - Another important issue is where are git repositories you want to make
53   available to gitweb. By default gitweb searches for repositories under
54   /pub/git; if you want to have projects somewhere else, like /home/git,
55   use GITWEB_PROJECTROOT build configuration variable.
57   By default all git repositories under projectroot are visible and
58   available to gitweb. The list of projects is generated by default by
59   scanning the projectroot directory for git repositories. This can be
60   changed (configured) as described in "Gitweb repositories" section
61   below.
63   Note that gitweb deals directly with the object database, and does not
64   need a working directory; the name of the project is the name of its
65   repository object database, usually projectname.git for bare
66   repositories. If you want to provide gitweb access to non-bare (live)
67   repositories, you can make projectname.git a symbolic link under
68   projectroot linking to projectname/.git (but it is just
69   a suggestion).
71 - You can control where gitweb tries to find its main CSS style file,
72   its favicon and logo with the GITWEB_CSS, GITWEB_FAVICON and GITWEB_LOGO
73   build configuration variables. By default gitweb tries to find them
74   in the same directory as gitweb.cgi script.
76 Build example
77 ~~~~~~~~~~~~~
79 - To install gitweb to /var/www/cgi-bin/gitweb/ when git wrapper
80   is installed at /usr/local/bin/git and the repositories (projects)
81   we want to display are under /home/local/scm, you can do
83         make GITWEB_PROJECTROOT="/home/local/scm" \
84              GITWEB_CSS="/gitweb/gitweb.css" \
85              GITWEB_LOGO="/gitweb/git-logo.png" \
86              GITWEB_FAVICON="/gitweb/git-favicon.png" \
87              bindir=/usr/local/bin \
88              gitweb/gitweb.cgi
90         cp -fv ~/git/gitweb/gitweb.{cgi,css} \
91                ~/git/gitweb/git-{favicon,logo}.png \
92              /var/www/cgi-bin/gitweb/
95 Gitweb config file
96 ------------------
98 See also "Runtime gitweb configuration" section in README file
99 for gitweb (in gitweb/README).
101 - You can configure gitweb further using the gitweb configuration file;
102   by default this is a file named gitweb_config.perl in the same place as
103   gitweb.cgi script. You can control the default place for the config file
104   using the GITWEB_CONFIG build configuration variable, and you can set it
105   using the GITWEB_CONFIG environment variable. If this file does not
106   exist, gitweb looks for a system-wide configuration file, normally
107   /etc/gitweb.conf. You can change the default using the
108   GITWEB_CONFIG_SYSTEM build configuration variable, and override it
109   through the GITWEB_CONFIG_SYSTEM environment variable.
111 - The gitweb config file is a fragment of perl code. You can set variables
112   using "our $variable = value"; text from "#" character until the end
113   of a line is ignored. See perlsyn(1) for details.
115   See the top of gitweb.perl file for examples of customizable options.
117 Config file example
118 ~~~~~~~~~~~~~~~~~~~
120 To enable blame, pickaxe search, and snapshot support, while allowing
121 individual projects to turn them off, put the following in your
122 GITWEB_CONFIG file:
124         $feature{'blame'}{'default'} = [1];
125         $feature{'blame'}{'override'} = 1;
127         $feature{'pickaxe'}{'default'} = [1];
128         $feature{'pickaxe'}{'override'} = 1;
130         $feature{'snapshot'}{'default'} = ['zip', 'tgz'];
131         $feature{'snapshot'}{'override'} = 1;
134 Gitweb repositories
135 -------------------
137 - By default all git repositories under projectroot are visible and
138   available to gitweb. The list of projects is generated by default by
139   scanning the projectroot directory for git repositories (for object
140   databases to be more exact).
142   You can provide a pre-generated list of [visible] repositories,
143   together with information about their owners (the project ownership
144   defaults to the owner of the repository directory otherwise), by setting
145   the GITWEB_LIST build configuration variable (or the $projects_list
146   variable in the gitweb config file) to point to a plain file.
148   Each line of the projects list file should consist of the url-encoded path
149   to the project repository database (relative to projectroot), followed
150   by the url-encoded project owner on the same line (separated by a space).
151   Spaces in both project path and project owner have to be encoded as either
152   '%20' or '+'.
154   Other characters that have to be url-encoded, i.e. replaced by '%'
155   followed by two-digit character number in octal, are: other whitespace
156   characters (because they are field separator in a record), plus sign '+'
157   (because it can be used as replacement for spaces), and percent sign '%'
158   (which is used for encoding / escaping).
160   You can generate the projects list index file using the project_index
161   action (the 'TXT' link on projects list page) directly from gitweb.
163 - By default, even if a project is not visible on projects list page, you
164   can view it nevertheless by hand-crafting a gitweb URL. You can set the
165   GITWEB_STRICT_EXPORT build configuration variable (or the $strict_export
166   variable in the gitweb config file) to only allow viewing of
167   repositories also shown on the overview page.
169 - Alternatively, you can configure gitweb to only list and allow
170   viewing of the explicitly exported repositories, via the
171   GITWEB_EXPORT_OK build configuration variable (or the $export_ok
172   variable in gitweb config file). If it evaluates to true, gitweb
173   shows repositories only if this file exists in its object database
174   (if directory has the magic file named $export_ok).
176 Generating projects list using gitweb
177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179 We assume that GITWEB_CONFIG has its default Makefile value, namely
180 gitweb_config.perl. Put the following in gitweb_make_index.perl file:
182         $GITWEB_CONFIG = "gitweb_config.perl";
183         do $GITWEB_CONFIG if -e $GITWEB_CONFIG;
185         $projects_list = $projectroot;
187 Then create the following script to get list of project in the format
188 suitable for GITWEB_LIST build configuration variable (or
189 $projects_list variable in gitweb config):
191         #!/bin/sh
193         export GITWEB_CONFIG="gitweb_make_index.perl"
194         export GATEWAY_INTERFACE="CGI/1.1"
195         export HTTP_ACCEPT="*/*"
196         export REQUEST_METHOD="GET"
197         export QUERY_STRING="a=project_index"
199         perl -- /var/www/cgi-bin/gitweb.cgi
202 Requirements
203 ------------
205  - Core git tools
206  - Perl
207  - Perl modules: CGI, Encode, Fcntl, File::Find, File::Basename.
208  - web server
211 Example web server configuration
212 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
214 See also "Webserver configuration" section in README file for gitweb
215 (in gitweb/README).
218 - Apache2, gitweb installed as CGI script,
219   under /var/www/cgi-bin/
221         ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"
223         <Directory "/var/www/cgi-bin">
224             Options Indexes FollowSymlinks ExecCGI
225             AllowOverride None
226             Order allow,deny
227             Allow from all
228         </Directory>
230 - Apache2, gitweb installed as mod_perl legacy script,
231   under /var/www/perl/
233         Alias /perl "/var/www/perl"
235         <Directory "/var/www/perl">
236             SetHandler perl-script
237             PerlResponseHandler ModPerl::Registry
238             PerlOptions +ParseHeaders
239             Options Indexes FollowSymlinks +ExecCGI
240             AllowOverride None
241             Order allow,deny
242             Allow from all
243         </Directory>