1cgit - CGI for Git
 2==================
 3
 4This is an attempt to create a fast web interface for the Git SCM, using a
 5built-in cache to decrease server I/O pressure.
 6
 7Installation
 8------------
 9
10Building cgit involves building a proper version of Git. How to do this
11depends on how you obtained the cgit sources:
12
13a) If you're working in a cloned cgit repository, you first need to
14initialize and update the Git submodule:
15
16    $ git submodule init     # register the Git submodule in .git/config
17    $ $EDITOR .git/config    # if you want to specify a different url for git
18    $ git submodule update   # clone/fetch and checkout correct git version
19
20b) If you're building from a cgit tarball, you can download a proper git
21version like this:
22
23    $ make get-git
24
25When either a) or b) has been performed, you can build and install cgit like
26this:
27
28    $ make
29    $ sudo make install
30
31This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
32can configure this location (and a few other things) by providing a `cgit.conf`
33file (see the Makefile for details).
34
35Dependencies
36------------
37
38* git 1.7.4
39* zip lib
40* crypto lib
41* openssl lib
42
43Apache configuration
44--------------------
45
46A new `Directory` section must probably be added for cgit, possibly something
47like this:
48
49    <Directory "/var/www/htdocs/cgit/">
50        AllowOverride None
51        Options +ExecCGI
52        Order allow,deny
53        Allow from all
54    </Directory>
55
56
57Runtime configuration
58---------------------
59
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).
63
64The cache
65---------
66
67When cgit is invoked it looks for a cache file matching the request and
68returns it to the client. If no such cache file exists (or if it has expired),
69the content for the request is written into the proper cache file before the
70file is returned.
71
72If the cache file has expired but cgit is unable to obtain a lock for it, the
73stale cache file is returned to the client. This is done to favour page
74throughput over page freshness.
75
76The generated content contains the complete response to the client, including
77the HTTP headers `Modified` and `Expires`.
78
79Online presence
80---------------
81
82* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
83
84* Patches, bug reports, discussions and support should go to the cgit
85  mailing list: <cgit@lists.zx2c4.com>. To sign up, visit 
86  <http://lists.zx2c4.com/mailman/listinfo/cgit>