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 affect 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 the most important is where to find the git wrapper binary. Gitweb
  38   tries to find the 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 the 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 searches 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. The 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 the object database, and does not
  57   need a 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   repositories, you can make projectname.git a 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 the 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 the gitweb configuration file;
  95   by default this is a file named gitweb_config.perl in the same place as
  96   gitweb.cgi script. You can control the default place for the config file
  97   using the GITWEB_CONFIG build configuration variable, and you can set it
  98   using the GITWEB_CONFIG environment 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 the GITWEB_CONFIG_SYSTEM environment variable.
 103
 104 - The gitweb config file is a 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 If you allow overriding for the snapshot feature, you can specify which
 127 snapshot formats are globally disabled. You can also add any command line
 128 options you want (such as setting the compression level). For instance,
 129 you can disable Zip compressed snapshots and set GZip to run at level 6 by
 130 adding the following lines to your $GITWEB_CONFIG:
 131
 132         $known_snapshot_formats{'zip'}{'disabled'} = 1;
 133         $known_snapshot_formats{'tgz'}{'compressor'} = ['gzip','-6'];
 134
 135
 136 Gitweb repositories
 137 -------------------
 138
 139 - By default all git repositories under projectroot are visible and
 140   available to gitweb. The list of projects is generated by default by
 141   scanning the projectroot directory for git repositories (for object
 142   databases to be more exact).
 143
 144   You can provide a pre-generated list of [visible] repositories,
 145   together with information about their owners (the project ownership
 146   defaults to the owner of the repository directory otherwise), by setting
 147   the GITWEB_LIST build configuration variable (or the $projects_list
 148   variable in the gitweb config file) to point to a plain file.
 149
 150   Each line of the projects list file should consist of the url-encoded path
 151   to the project repository database (relative to projectroot), followed
 152   by the url-encoded project owner on the same line (separated by a space).
 153   Spaces in both project path and project owner have to be encoded as either
 154   '%20' or '+'.
 155
 156   Other characters that have to be url-encoded, i.e. replaced by '%'
 157   followed by two-digit character number in octal, are: other whitespace
 158   characters (because they are field separator in a record), plus sign '+'
 159   (because it can be used as replacement for spaces), and percent sign '%'
 160   (which is used for encoding / escaping).
 161
 162   You can generate the projects list index file using the project_index
 163   action (the 'TXT' link on projects list page) directly from gitweb.
 164
 165 - By default, even if a project is not visible on projects list page, you
 166   can view it nevertheless by hand-crafting a gitweb URL. You can set the
 167   GITWEB_STRICT_EXPORT build configuration variable (or the $strict_export
 168   variable in the gitweb config file) to only allow viewing of
 169   repositories also shown on the overview page.
 170
 171 - Alternatively, you can configure gitweb to only list and allow
 172   viewing of the explicitly exported repositories, via the
 173   GITWEB_EXPORT_OK build configuration variable (or the $export_ok
 174   variable in gitweb config file). If it evaluates to true, gitweb
 175   shows repositories only if this file exists in its object database
 176   (if directory has the magic file named $export_ok).
 177
 178 - Finally, it is possible to specify an arbitrary perl subroutine that
 179   will be called for each project to determine if it can be exported.
 180   The subroutine receives an absolute path to the project as its only
 181   parameter.
 182
 183   For example, if you use mod_perl to run the script, and have dumb
 184   http protocol authentication configured for your repositories, you
 185   can use the following hook to allow access only if the user is
 186   authorized to read the files:
 187
 188     $export_auth_hook = sub {
 189         use Apache2::SubRequest ();
 190         use Apache2::Const -compile => qw(HTTP_OK);
 191         my $path = "$_[0]/HEAD";
 192         my $r    = Apache2::RequestUtil->request;
 193         my $sub  = $r->lookup_file($path);
 194         return $sub->filename eq $path
 195             && $sub->status == Apache2::Const::HTTP_OK;
 196     };
 197
 198
 199 Generating projects list using gitweb
 200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 201
 202 We assume that GITWEB_CONFIG has its default Makefile value, namely
 203 gitweb_config.perl. Put the following in gitweb_make_index.perl file:
 204
 205         $GITWEB_CONFIG = "gitweb_config.perl";
 206         do $GITWEB_CONFIG if -e $GITWEB_CONFIG;
 207
 208         $projects_list = $projectroot;
 209
 210 Then create the following script to get list of project in the format
 211 suitable for GITWEB_LIST build configuration variable (or
 212 $projects_list variable in gitweb config):
 213
 214         #!/bin/sh
 215
 216         export GITWEB_CONFIG="gitweb_make_index.perl"
 217         export GATEWAY_INTERFACE="CGI/1.1"
 218         export HTTP_ACCEPT="*/*"
 219         export REQUEST_METHOD="GET"
 220         export QUERY_STRING="a=project_index"
 221
 222         perl -- /var/www/cgi-bin/gitweb.cgi
 223
 224
 225 Requirements
 226 ------------
 227
 228  - Core git tools
 229  - Perl
 230  - Perl modules: CGI, Encode, Fcntl, File::Find, File::Basename.
 231  - web server
 232
 233
 234 Example web server configuration
 235 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 236
 237 See also "Webserver configuration" section in README file for gitweb
 238 (in gitweb/README).
 239
 240
 241 - Apache2, gitweb installed as CGI script,
 242   under /var/www/cgi-bin/
 243
 244         ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"
 245
 246         <Directory "/var/www/cgi-bin">
 247             Options Indexes FollowSymlinks ExecCGI
 248             AllowOverride None
 249             Order allow,deny
 250             Allow from all
 251         </Directory>
 252
 253 - Apache2, gitweb installed as mod_perl legacy script,
 254   under /var/www/perl/
 255
 256         Alias /perl "/var/www/perl"
 257
 258         <Directory "/var/www/perl">
 259             SetHandler perl-script
 260             PerlResponseHandler ModPerl::Registry
 261             PerlOptions +ParseHeaders
 262             Options Indexes FollowSymlinks +ExecCGI
 263             AllowOverride None
 264             Order allow,deny
 265             Allow from all
 266         </Directory>