1
 2                       cgit - cgi for git
 3
 4
 5This is an attempt to create a fast web interface for the git scm, using a
 6builtin cache to decrease server io-pressure.
 7
 8
 9Installation
10
11$ $EDITOR Makefile
12$ make
13$ sudo make install
14
15Note: cgit requires the git and xdiff libraries. Currently, the makefile
16expects these files to be found in '../git/libgit.a' and '../git/xdiff/lib.a',
17where they will be if you have built git from source in a parallell directory.
18
19
20Runtime configuration
21
22The file /etc/cgitrc is read by cgit before handling a request. A template 
23cgitrc is shipped with the sources, and all parameters and default values 
24can be found in this file.
25
26
27The cache
28
29When cgit is invoked it looks for a cachefile matching the request and 
30returns it to the client. If no such cachefile exist (or if it has expired), 
31the content for the request is written into the proper cachefile before the
32file is returned.
33
34If the cachefile has expired but cgit is unable to obtain a lock for it, the 
35stale cachefile is returned to the client. This is done to favour page
36throughput over page freshness.
37
38The generated content contains the complete response to the client, including
39the http-headers "Modified" and "Expires".