cgit with patches for sandboxing using qssb
Go to file
Jeffrey C. Ollie e651cb0d2d Rename dirlink to gitlink.
Git changed from dirlink to gitlink in
302b9282c9ddfcc704ca759bdc98c1d5f75eba2f.

Signed-off-by: Jeffrey C. Ollie <jeff@ocjtech.us>
2007-06-04 19:58:32 +02:00
git@aba170cdb4 Use git-1.5.2 2007-05-20 13:41:05 +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 cache_safe_filename() needs more buffers 2007-05-18 22:51:02 +02:00
cgit.c Add option to disable pager to cgit_print_log(). 2007-05-31 10:24:37 +02:00
cgit.css Add repo.readme parameter 2007-05-23 22:46:54 +02:00
cgit.h Implemented configurable HEAD shortlog on summary page. 2007-05-31 10:25:48 +02:00
cgitrc Implemented configurable HEAD shortlog on summary page. 2007-05-31 10:25:48 +02:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
html.c Rename dirlink to gitlink. 2007-06-04 19:58:32 +02:00
Makefile cgit v0.5 2007-05-24 00:18:16 +02:00
parsing.c Check for NULL commit buffer in cgit_parse_commit() 2007-05-31 10:24:43 +02:00
README Update README with submodule build info 2007-05-11 12:13:15 +02:00
shared.c Implemented configurable HEAD shortlog on summary page. 2007-05-31 10:25:48 +02: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 Use &amp; instead of & in URLs. 2007-05-31 10:18:38 +02:00
ui-diff.c Rename dirlink to gitlink. 2007-06-04 19:58:32 +02:00
ui-log.c Add option to disable pager to cgit_print_log(). 2007-05-31 10:24:37 +02:00
ui-repolist.c Remove unused variable from ui-repolist.c:read_agefile() 2007-05-23 19:22:20 +02:00
ui-shared.c Use &amp; instead of & in URLs. 2007-05-31 10:18:38 +02:00
ui-snapshot.c Add support for snapshots 2007-02-08 13:58:58 +01:00
ui-summary.c Implemented configurable HEAD shortlog on summary page. 2007-05-31 10:25:48 +02:00
ui-tree.c Rename dirlink to gitlink. 2007-06-04 19:58:32 +02:00
ui-view.c Use &amp; instead of & in URLs. 2007-05-31 10:18:38 +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
  $ su
  $ make install

This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".

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

  $ git clone -s <path-to-git-repo> git
  $ ./submodules.sh -u

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:

  <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".


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.