2006-12-10 21:31:36 +00:00
|
|
|
|
2006-12-13 01:06:29 +00:00
|
|
|
cgit - cgi for git
|
|
|
|
|
|
|
|
|
|
|
2007-01-28 12:18:23 +00:00
|
|
|
This is an attempt to create a fast web interface for the git scm, using a
|
|
|
|
|
builtin cache to decrease server io-pressure.
|
2006-12-13 01:06:29 +00:00
|
|
|
|
|
|
|
|
|
2007-01-28 12:18:23 +00:00
|
|
|
Installation
|
|
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
$ make
|
2007-02-04 22:57:34 +00:00
|
|
|
$ su
|
2007-05-11 10:13:15 +00:00
|
|
|
$ make install
|
2007-01-28 12:18:23 +00:00
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".
|
2007-02-04 22:57:34 +00:00
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
Note: The initial "make" will create a submodule 'git' and clone the git
|
|
|
|
|
repository at git://git.kernel.org/pub/scm/git/git.git in it. If you
|
|
|
|
|
already have a local git git repository that you want to use as origin
|
|
|
|
|
for the submodule, run
|
2007-02-04 22:57:34 +00:00
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
$ git clone -s <path-to-git-repo> git
|
|
|
|
|
$ ./submodules.sh -u
|
2007-02-04 22:57:34 +00:00
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
before running "make".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Dependencies
|
|
|
|
|
|
|
|
|
|
-git (1.5.2-rc0 or newer, due to git submodule) installed
|
|
|
|
|
-zip lib
|
|
|
|
|
-crypto lib
|
|
|
|
|
-openssl lib
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Apache configuration
|
|
|
|
|
|
|
|
|
|
A new Directory-section must probably be added for cgit, possibly something
|
|
|
|
|
like this:
|
2007-02-04 22:57:34 +00:00
|
|
|
|
|
|
|
|
<Directory "/var/www/htdocs/cgit/">
|
|
|
|
|
AllowOverride None
|
|
|
|
|
Options ExecCGI
|
|
|
|
|
Order allow,deny
|
|
|
|
|
Allow from all
|
|
|
|
|
</Directory>
|
2007-01-28 12:18:23 +00:00
|
|
|
|
2006-12-13 01:06:29 +00:00
|
|
|
|
2007-01-28 12:18:23 +00:00
|
|
|
Runtime configuration
|
2006-12-13 01:06:29 +00:00
|
|
|
|
2007-02-04 22:57:34 +00:00
|
|
|
The file /etc/cgitrc is read by cgit before handling a request. In addition
|
2007-05-11 10:13:15 +00:00
|
|
|
to runtime parameters, this file also contains a list of the repositories
|
2007-02-04 22:57:34 +00:00
|
|
|
displayed by cgit.
|
|
|
|
|
|
|
|
|
|
A template cgitrc is shipped with the sources, and all parameters and default
|
2007-05-11 10:13:15 +00:00
|
|
|
values are documented in this file.
|
2006-12-13 01:06:29 +00:00
|
|
|
|
|
|
|
|
|
2007-01-28 12:18:23 +00:00
|
|
|
The cache
|
|
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
When cgit is invoked it looks for a cachefile matching the request and
|
|
|
|
|
returns it to the client. If no such cachefile exist (or if it has expired),
|
2007-01-28 12:18:23 +00:00
|
|
|
the content for the request is written into the proper cachefile before the
|
|
|
|
|
file is returned.
|
|
|
|
|
|
2007-05-11 10:13:15 +00:00
|
|
|
If the cachefile has expired but cgit is unable to obtain a lock for it, the
|
2007-01-28 12:18:23 +00:00
|
|
|
stale cachefile is returned to the client. This is done to favour page
|
|
|
|
|
throughput over page freshness.
|
2006-12-13 01:06:29 +00:00
|
|
|
|
2007-01-28 12:18:23 +00:00
|
|
|
The generated content contains the complete response to the client, including
|
|
|
|
|
the http-headers "Modified" and "Expires".
|
2007-05-11 10:13:15 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
The mis(sing) features
|
|
|
|
|
|
|
|
|
|
Submodule links in the directory listing page have a fixed format per
|
|
|
|
|
repository. This should probably be extended to a generic map between
|
|
|
|
|
submodule path and url.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The end.
|
