cgit with patches for sandboxing using qssb
Go to file
Lars Hjemli cc1dbd1b5d Add submodules.sh and use it during builds
This adds a shell script which can be be used to initialize, list and
update submodules in a git repository. It reads the file .gitmodules
to find a mapping between submodule path and repository url for the
initial clone of all submodules.

The script is used during cgit builds to enable automatic download and
checkout of the git git repository.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-05-11 11:03:52 +02:00
git@9159afbfce Added git as a submodule 2007-05-11 10:59:10 +02:00
.gitignore Add caching infrastructure 2006-12-10 22:31:36 +01:00
.gitmodules Add submodules.sh and use it during builds 2007-05-11 11:03:52 +02:00
cache.c Remove troublesome chars from cachefile names 2007-01-12 00:24:35 +01:00
cgit.c Add support for downloading single blobs 2007-05-09 00:48:09 +02:00
cgit.css Layout update 2007-02-21 00:24:36 +01:00
cgit.h Add support for downloading single blobs 2007-05-09 00:48:09 +02:00
cgitrc Make snapshot feature configurable 2007-02-08 14:47:56 +01:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
html.c Add generic support for search box in page header 2006-12-28 02:01:49 +01:00
Makefile Add submodules.sh and use it during builds 2007-05-11 11:03:52 +02:00
parsing.c Update to libgit 1.5.2-rc2 2007-05-08 23:38:49 +02:00
README Add support for prefix and gitsrc arguments to 'make' 2007-02-05 00:12:04 +01:00
shared.c Make snapshot feature configurable 2007-02-08 14:47:56 +01:00
submodules.sh Add submodules.sh and use it during builds 2007-05-11 11:03:52 +02:00
ui-blob.c Add support for downloading single blobs 2007-05-09 00:48:09 +02:00
ui-commit.c Make snapshot feature configurable 2007-02-08 14:47:56 +01:00
ui-diff.c Update to libgit 1.5.2-rc2 2007-05-08 23:38:49 +02:00
ui-log.c Layout update 2007-02-21 00:24:36 +01:00
ui-repolist.c Layout update 2007-02-21 00:24:36 +01:00
ui-shared.c Layout update 2007-02-21 00:24:36 +01:00
ui-snapshot.c Add support for snapshots 2007-02-08 13:58:58 +01:00
ui-summary.c Update to libgit 1.5.2-rc2 2007-05-08 23:38:49 +02:00
ui-tree.c Update to libgit 1.5.2-rc2 2007-05-08 23:38:49 +02:00
ui-view.c Add support for downloading single blobs 2007-05-09 00:48:09 +02:00

                       cgit - cgi for git


This is an attempt to create a fast web interface for the git scm, using a
builtin cache to decrease server io-pressure.


Installation

  $ make gitsrc=<path>
  $ su
  $ make prefix=<path> install


Default value for gitsrc is "../git", and this directory should contain the
git sources.

Default value for prefix is "/var/www/htdocs/cgit". This directory will 
contain "cgit.cgi" and "cgit.css" after 'make install'.

After installation, httpd.conf probably must be updated with a Directory-
section for cgit, possibly something like this:

  <Directory "/var/www/htdocs/cgit/">
      AllowOverride None
      Options ExecCGI
      Order allow,deny
      Allow from all
  </Directory>


Runtime configuration

The file /etc/cgitrc is read by cgit before handling a request. In addition
to runtime parameters, this file also contains a list of the repositories 
displayed by cgit.

A template cgitrc is shipped with the sources, and all parameters and default
values are documented in this file. 


The cache

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), 
the content for the request is written into the proper cachefile before the
file is returned.

If the cachefile has expired but cgit is unable to obtain a lock for it, the 
stale cachefile is returned to the client. This is done to favour page
throughput over page freshness.

The generated content contains the complete response to the client, including
the http-headers "Modified" and "Expires".