2 cgit - cgi for git
5This is an attempt to create a fast web interface for the git scm, using a
6builtin cache to decrease server io-pressure.
11Building cgit involves building a proper version of git. How to do this
12depends on how you obtained the cgit sources:
14a) If you're working in a cloned cgit repository, you first need to
15initialize and update the git submodule:
17 $ git submodule init # register the git submodule in .git/config
18 $ $EDITOR .git/config # if you want to specify a different url for git
19 $ git submodule update # clone/fetch and checkout correct git version
21b) If you're building from a cgit tarball, you can download a proper git
22version like this:
24 $ make get-git
27When either a) or b) has been performed, you can build and install cgit like
30 $ make
31 $ sudo make install
33This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit". You can
34configure this location (and a few other things) by providing a "cgit.conf"
35file (see the Makefile for details).
39 -git 1.7.4
40 -zip lib
41 -crypto lib
42 -openssl lib
47A new Directory-section must probably be added for cgit, possibly something
50 <Directory "/var/www/htdocs/cgit/">
51 AllowOverride None
52 Options +ExecCGI
53 Order allow,deny
54 Allow from all
60The file /etc/cgitrc is read by cgit before handling a request. In addition
61to runtime parameters, this file may also contain a list of repositories
62displayed by cgit (see cgitrc.5.txt for further details).
67When cgit is invoked it looks for a cachefile matching the request and
68returns it to the client. If no such cachefile exist (or if it has expired),
69the content for the request is written into the proper cachefile before the
70file is returned.
72If the cachefile has expired but cgit is unable to obtain a lock for it, the
73stale cachefile is returned to the client. This is done to favour page
74throughput over page freshness.
76The generated content contains the complete response to the client, including
77the http-headers "Modified" and "Expires".
82* The cgit homepage is hosted by cgit at http://git.zx2c4.com/cgit/about
84* Patches, bugreports, discussions and support should go to the cgit
85 mailing list: email@example.com