Merge branch 'jk/use-our-regexp'
[git] / gitweb / README
1 GIT web Interface
2 =================
3
4 The one working on:
5   http://git.kernel.org/
6
7 From the git version 1.4.0 gitweb is bundled with git.
8
9
10 How to configure gitweb for your local system
11 ---------------------------------------------
12
13 See also the "Build time configuration" section in the INSTALL
14 file for gitweb (in gitweb/INSTALL).
15
16 You can specify the following configuration variables when building GIT:
17  * GIT_BINDIR
18    Points where to find the git executable.  You should set it up to
19    the place where the git binary was installed (usually /usr/bin) if you
20    don't install git from sources together with gitweb.  [Default: $(bindir)]
21  * GITWEB_SITENAME
22    Shown in the title of all generated pages, defaults to the server name
23    (SERVER_NAME CGI environment variable) if not set. [No default]
24  * GITWEB_PROJECTROOT
25    The root directory for all projects shown by gitweb. Must be set
26    correctly for gitweb to find repositories to display.  See also
27    "Gitweb repositories" in the INSTALL file for gitweb.  [Default: /pub/git]
28  * GITWEB_PROJECT_MAXDEPTH
29    The filesystem traversing limit for getting the project list; the number
30    is taken as depth relative to the projectroot.  It is used when
31    GITWEB_LIST is a directory (or is not set; then project root is used).
32    Is is meant to speed up project listing on large work trees by limiting
33    search depth.  [Default: 2007]
34  * GITWEB_LIST
35    Points to a directory to scan for projects (defaults to project root
36    if not set / if empty) or to a file with explicit listing of projects
37    (together with projects' ownership). See "Generating projects list
38    using gitweb" in INSTALL file for gitweb to find out how to generate
39    such file from scan of a directory. [No default, which means use root
40    directory for projects]
41  * GITWEB_EXPORT_OK
42    Show repository only if this file exists (in repository).  Only
43    effective if this variable evaluates to true.  [No default / Not set]
44  * GITWEB_STRICT_EXPORT
45    Only allow viewing of repositories also shown on the overview page.
46    This for example makes GITWEB_EXPORT_OK to decide if repository is
47    available and not only if it is shown.  If GITWEB_LIST points to
48    file with list of project, only those repositories listed would be
49    available for gitweb.  [No default]
50  * GITWEB_HOMETEXT
51    Points to an .html file which is included on the gitweb project
52    overview page ('projects_list' view), if it exists.  Relative to
53    gitweb.cgi script.  [Default: indextext.html]
54  * GITWEB_SITE_HEADER
55    Filename of html text to include at top of each page.  Relative to
56    gitweb.cgi script.  [No default]
57  * GITWEB_SITE_FOOTER
58    Filename of html text to include at bottom of each page.  Relative to
59    gitweb.cgi script.  [No default]
60  * GITWEB_HOME_LINK_STR
61    String of the home link on top of all pages, leading to $home_link
62    (usually main gitweb page, which means projects list).  Used as first
63    part of gitweb view "breadcrumb trail": <home> / <project> / <view>.
64    [Default: projects]
65  * GITWEB_SITENAME
66    Name of your site or organization to appear in page titles.  Set it
67    to something descriptive for clearer bookmarks etc.  If not set
68    (if empty) gitweb uses "$SERVER_NAME Git", or "Untitled Git" if
69    SERVER_NAME CGI environment variable is not set (e.g. if running
70    gitweb as standalone script).  [No default]
71  * GITWEB_BASE_URL
72    Git base URLs used for URL to where fetch project from, i.e. full
73    URL is "$git_base_url/$project".  Shown on projects summary page.
74    Repository URL for project can be also configured per repository; this
75    takes precedence over URLs composed from base URL and a project name.
76    Note that you can setup multiple base URLs (for example one for
77    git:// protocol access, another for http:// access) from the gitweb
78    config file.  [No default]
79  * GITWEB_CSS
80    Points to the location where you put gitweb.css on your web server
81    (or to be more generic, the URI of gitweb stylesheet).  Relative to the
82    base URI of gitweb.  Note that you can setup multiple stylesheets from
83    the gitweb config file.  [Default: gitweb.css]
84  * GITWEB_LOGO
85    Points to the location where you put git-logo.png on your web server
86    (or to be more generic URI of logo, 72x27 size, displayed in top right
87    corner of each gitweb page, and used as logo for Atom feed).  Relative
88    to base URI of gitweb.  [Default: git-logo.png]
89  * GITWEB_FAVICON
90    Points to the location where you put git-favicon.png on your web server
91    (or to be more generic URI of favicon, assumed to be image/png type;
92    web browsers that support favicons (website icons) may display them
93    in the browser's URL bar and next to site name in bookmarks).  Relative
94    to base URI of gitweb.  [Default: git-favicon.png]
95  * GITWEB_CONFIG
96    This Perl file will be loaded using 'do' and can be used to override any
97    of the options above as well as some other options -- see the "Runtime
98    gitweb configuration" section below, and top of 'gitweb.cgi' for their
99    full list and description.  If the environment variable GITWEB_CONFIG
100    is set when gitweb.cgi is executed, then the file specified in the
101    environment variable will be loaded instead of the file specified
102    when gitweb.cgi was created.  [Default: gitweb_config.perl]
103  * GITWEB_CONFIG_SYSTEM
104    This Perl file will be loaded using 'do' as a fallback if GITWEB_CONFIG
105    does not exist.  If the environment variable GITWEB_CONFIG_SYSTEM is set
106    when gitweb.cgi is executed, then the file specified in the environment
107    variable will be loaded instead of the file specified when gitweb.cgi was
108    created.  [Default: /etc/gitweb.conf]
109
110
111 Runtime gitweb configuration
112 ----------------------------
113
114 You can adjust gitweb behaviour using the file specified in `GITWEB_CONFIG`
115 (defaults to 'gitweb_config.perl' in the same directory as the CGI), and
116 as a fallback `GITWEB_CONFIG_SYSTEM` (defaults to /etc/gitweb.conf).
117 The most notable thing that is not configurable at compile time are the
118 optional features, stored in the '%features' variable.
119
120 Ultimate description on how to reconfigure the default features setting
121 in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found
122 as comments inside 'gitweb.cgi'.
123
124 See also the "Gitweb config file" (with an example of config file), and
125 the "Gitweb repositories" sections in INSTALL file for gitweb.
126
127
128 The gitweb config file is a fragment of perl code. You can set variables
129 using "our $variable = value"; text from "#" character until the end
130 of a line is ignored. See perlsyn(1) man page for details.
131
132 Below is the list of variables which you might want to set in gitweb config.
133 See the top of 'gitweb.cgi' for the full list of variables and their
134 descriptions.
135
136 Gitweb config file variables
137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138
139 You can set, among others, the following variables in gitweb config files
140 (with the exception of $projectroot and $projects_list this list does
141 not include variables usually directly set during build):
142  * $GIT
143    Core git executable to use.  By default set to "$GIT_BINDIR/git", which
144    in turn is by default set to "$(bindir)/git".  If you use git from binary
145    package, set this to "/usr/bin/git".  This can just be "git" if your
146    webserver has a sensible PATH.  If you have multiple git versions
147    installed it can be used to choose which one to use.
148  * $version
149    Gitweb version, set automatically when creating gitweb.cgi from
150    gitweb.perl. You might want to modify it if you are running modified
151    gitweb.
152  * $projectroot
153    Absolute filesystem path which will be prepended to project path;
154    the path to repository is $projectroot/$project.  Set to
155    $GITWEB_PROJECTROOT during installation.  This variable have to be
156    set correctly for gitweb to find repositories.
157  * $projects_list
158    Source of projects list, either directory to scan, or text file
159    with list of repositories (in the "<URI-encoded repository path> SP
160    <URI-encoded repository owner>" line format; actually there can be
161    any sequence of whitespace in place of space (SP)).  Set to
162    $GITWEB_LIST during installation.  If empty, $projectroot is used
163    to scan for repositories.
164  * $my_url, $my_uri
165    Full URL and absolute URL of gitweb script;
166    in earlier versions of gitweb you might have need to set those
167    variables, now there should be no need to do it.
168  * $home_link
169    Target of the home link on top of all pages (the first part of view
170    "breadcrumbs").  By default set to absolute URI of a page ($my_uri).
171  * @stylesheets
172    List of URIs of stylesheets (relative to base URI of a page). You
173    might specify more than one stylesheet, for example use gitweb.css
174    as base, with site specific modifications in separate stylesheet
175    to make it easier to upgrade gitweb. You can add 'site' stylesheet
176    for example by using
177       push @stylesheets, "gitweb-site.css";
178    in the gitweb config file.
179  * $logo_url, $logo_label
180    URI and label (title) of GIT logo link (or your site logo, if you choose
181    to use different logo image). By default they point to git homepage;
182    in the past they pointed to git documentation at www.kernel.org.
183  * $projects_list_description_width
184    The width (in characters) of the projects list "Description" column.
185    Longer descriptions will be cut (trying to cut at word boundary);
186    full description is available as 'title' attribute (usually shown on
187    mouseover).  By default set to 25, which might be too small if you
188    use long project descriptions.
189  * @git_base_url_list
190    List of git base URLs used for URL to where fetch project from, shown
191    in project summary page.  Full URL is "$git_base_url/$project".
192    You can setup multiple base URLs (for example one for  git:// protocol
193    access, and one for http:// "dumb" protocol access).  Note that per
194    repository configuration in 'cloneurl' file, or as values of gitweb.url
195    project config.
196  * $default_blob_plain_mimetype
197    Default mimetype for blob_plain (raw) view, if mimetype checking
198    doesn't result in some other type; by default 'text/plain'.
199  * $default_text_plain_charset
200    Default charset for text files. If not set, web server configuration
201    would be used.
202  * $mimetypes_file
203    File to use for (filename extension based) guessing of MIME types before
204    trying /etc/mime.types. Path, if relative, is taken currently as
205    relative to the current git repository.
206  * $fallback_encoding
207    Gitweb assumes this charset if line contains non-UTF-8 characters.
208    Fallback decoding is used without error checking, so it can be even
209    'utf-8'. Value must be valid encoding; see Encoding::Supported(3pm) man
210    page for a list.   By default 'latin1', aka. 'iso-8859-1'.
211  * @diff_opts
212    Rename detection options for git-diff and git-diff-tree. By default
213    ('-M'); set it to ('-C') or ('-C', '-C') to also detect copies, or
214    set it to () if you don't want to have renames detection.
215  * $prevent_xss
216    If true, some gitweb features are disabled to prevent content in
217    repositories from launching cross-site scripting (XSS) attacks.  Set this
218    to true if you don't trust the content of your repositories. The default
219    is false.
220
221
222 Projects list file format
223 ~~~~~~~~~~~~~~~~~~~~~~~~~
224
225 Instead of having gitweb find repositories by scanning filesystem starting
226 from $projectroot (or $projects_list, if it points to directory), you can
227 provide list of projects by setting $projects_list to a text file with list
228 of projects (and some additional info).  This file uses the following
229 format:
230
231 One record (for project / repository) per line, whitespace separated fields;
232 does not support (at least for now) lines continuation (newline escaping).
233 Leading and trailing whitespace are ignored, any run of whitespace can be
234 used as field separator (rules for Perl's "split(' ', $line)").  Keyed by
235 the first field, which is project name, i.e. path to repository GIT_DIR
236 relative to $projectroot.  Fields use modified URI encoding, defined in
237 RFC 3986, section 2.1 (Percent-Encoding), or rather "Query string encoding"
238 (see http://en.wikipedia.org/wiki/Query_string#URL_encoding), the difference
239 being that SP (' ') can be encoded as '+' (and therefore '+' has to be also
240 percent-encoded).  Reserved characters are: '%' (used for encoding), '+'
241 (can be used to encode SPACE), all whitespace characters as defined in Perl,
242 including SP, TAB and LF, (used to separate fields in a record).
243
244 Currently list of fields is
245  * <repository path>  - path to repository GIT_DIR, relative to $projectroot
246  * <repository owner> - displayed as repository owner, preferably full name,
247                         or email, or both
248
249 You can additionally use $projects_list file to limit which repositories
250 are visible, and together with $strict_export to limit access to
251 repositories (see "Gitweb repositories" section in gitweb/INSTALL).
252
253
254 Per-repository gitweb configuration
255 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
256
257 You can also configure individual repositories shown in gitweb by creating
258 file in the GIT_DIR of git repository, or by setting some repo configuration
259 variable (in GIT_DIR/config).
260
261 You can use the following files in repository:
262  * README.html
263    A .html file (HTML fragment) which is included on the gitweb project
264    summary page inside <div> block element. You can use it for longer
265    description of a project, to provide links (for example to project's
266    homepage), etc. This is recognized only if XSS prevention is off
267    ($prevent_xss is false); a way to include a readme safely when XSS
268    prevention is on may be worked out in the future.
269  * description (or gitweb.description)
270    Short (shortened by default to 25 characters in the projects list page)
271    single line description of a project (of a repository). Plain text file;
272    HTML will be escaped. By default set to
273      Unnamed repository; edit this file to name it for gitweb.
274    from the template during repository creation. You can use the
275    gitweb.description repo configuration variable, but the file takes
276    precedence.
277  * cloneurl (or multiple-valued gitweb.url)
278    File with repository URL (used for clone and fetch), one per line.
279    Displayed in the project summary page. You can use multiple-valued
280    gitweb.url repository configuration variable for that, but the file
281    takes precedence.
282  * gitweb.owner
283    You can use the gitweb.owner repository configuration variable to set
284    repository's owner. It is displayed in the project list and summary
285    page. If it's not set, filesystem directory's owner is used
286    (via GECOS field / real name field from getpwiud(3)).
287  * various gitweb.* config variables (in config)
288    Read description of %feature hash for detailed list, and some
289    descriptions.
290
291
292 Webserver configuration
293 -----------------------
294
295 If you want to have one URL for both gitweb and your http://
296 repositories, you can configure apache like this:
297
298 <VirtualHost *:80>
299     ServerName git.example.org
300     DocumentRoot /pub/git
301     SetEnv      GITWEB_CONFIG   /etc/gitweb.conf
302     RewriteEngine on
303     # make the front page an internal rewrite to the gitweb script
304     RewriteRule ^/$  /cgi-bin/gitweb.cgi
305     # make access for "dumb clients" work
306     RewriteRule ^/(.*\.git/(?!/?(HEAD|info|objects|refs)).*)?$ /cgi-bin/gitweb.cgi%{REQUEST_URI}  [L,PT]
307 </VirtualHost>
308
309 The above configuration expects your public repositories to live under
310 /pub/git and will serve them as http://git.domain.org/dir-under-pub-git,
311 both as cloneable GIT URL and as browseable gitweb interface.
312 If you then start your git-daemon with --base-path=/pub/git --export-all
313 then you can even use the git:// URL with exactly the same path.
314
315 Setting the environment variable GITWEB_CONFIG will tell gitweb to use
316 the named file (i.e. in this example /etc/gitweb.conf) as a
317 configuration for gitweb.  Perl variables defined in here will
318 override the defaults given at the head of the gitweb.perl (or
319 gitweb.cgi).  Look at the comments in that file for information on
320 which variables and what they mean.
321
322 If you use the rewrite rules from the example you'll likely also need
323 something like the following in your gitweb.conf (or gitweb_config.perl) file:
324
325   @stylesheets = ("/some/absolute/path/gitweb.css");
326   $my_uri = "/";
327   $home_link = "/";
328
329
330 PATH_INFO usage
331 -----------------------
332 If you enable PATH_INFO usage in gitweb by putting
333
334    $feature{'pathinfo'}{'default'} = [1];
335
336 in your gitweb.conf, it is possible to set up your server so that it
337 consumes and produces URLs in the form
338
339 http://git.example.com/project.git/shortlog/sometag
340
341 by using a configuration such as the following, that assumes that
342 /var/www/gitweb is the DocumentRoot of your webserver, and that it
343 contains the gitweb.cgi script and complementary static files
344 (stylesheet, favicon):
345
346 <VirtualHost *:80>
347         ServerAlias git.example.com
348
349         DocumentRoot /var/www/gitweb
350
351         <Directory /var/www/gitweb>
352                 Options ExecCGI
353                 AddHandler cgi-script cgi
354
355                 DirectoryIndex gitweb.cgi
356
357                 RewriteEngine On
358                 RewriteCond %{REQUEST_FILENAME} !-f
359                 RewriteCond %{REQUEST_FILENAME} !-d
360                 RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
361         </Directory>
362 </VirtualHost>
363
364 The rewrite rule guarantees that existing static files will be properly
365 served, whereas any other URL will be passed to gitweb as PATH_INFO
366 parameter.
367
368 Notice that in this case you don't need special settings for
369 @stylesheets, $my_uri and $home_link, but you lose "dumb client" access
370 to your project .git dirs. A possible workaround for the latter is the
371 following: in your project root dir (e.g. /pub/git) have the projects
372 named without a .git extension (e.g. /pub/git/project instead of
373 /pub/git/project.git) and configure Apache as follows:
374
375 <VirtualHost *:80>
376         ServerAlias git.example.com
377
378         DocumentRoot /var/www/gitweb
379
380         AliasMatch ^(/.*?)(\.git)(/.*)?$ /pub/git$1$3
381         <Directory /var/www/gitweb>
382                 Options ExecCGI
383                 AddHandler cgi-script cgi
384
385                 DirectoryIndex gitweb.cgi
386
387                 RewriteEngine On
388                 RewriteCond %{REQUEST_FILENAME} !-f
389                 RewriteCond %{REQUEST_FILENAME} !-d
390                 RewriteRule ^.* /gitweb.cgi/$0 [L,PT]
391         </Directory>
392 </VirtualHost>
393
394 The additional AliasMatch makes it so that
395
396 http://git.example.com/project.git
397
398 will give raw access to the project's git dir (so that the project can
399 be cloned), while
400
401 http://git.example.com/project
402
403 will provide human-friendly gitweb access.
404
405 This solution is not 100% bulletproof, in the sense that if some project
406 has a named ref (branch, tag) starting with 'git/', then paths such as
407
408 http://git.example.com/project/command/abranch..git/abranch
409
410 will fail with a 404 error.
411
412
413
414 Originally written by:
415   Kay Sievers <kay.sievers@vrfy.org>
416
417 Any comment/question/concern to:
418   Git mailing list <git@vger.kernel.org>