A hyperfast web frontend for git repositories written in C.
Go to file
2008-03-23 11:36:38 +01:00
git@bc6100087c Use GIT-1.5.5.rc1 2008-03-23 11:36:38 +01:00
tests Fix segfault in patch view for root commit 2008-03-17 23:51:47 +01:00
.gitignore Add cgit.conf to .gitignore, remove *~ 2007-09-20 00:11:03 +02:00
.gitmodules Delete submodules.sh and prepare for using git-submodule 2007-09-03 22:54:51 +02:00
cache.c cache_safe_filename() needs more buffers 2007-05-18 22:51:02 +02:00
cgit.c Handle missing default branch and error out on invalid branch names 2008-01-04 13:43:40 +01:00
cgit.css Use tables for page layout 2007-11-16 09:52:03 +01:00
cgit.h Add plain patch view 2007-12-11 02:43:24 +01:00
cgit.png Gimp my logo 2007-11-16 09:51:35 +01:00
cgitrc Add support for automatic and custom clone urls 2007-12-03 01:49:38 +01:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
gen-version.sh gen-version.sh: don't sed the output from git describe 2007-10-01 12:09:41 +02:00
html.c Merge branch 'stable' 2008-02-23 20:14:01 +01:00
Makefile Use GIT-1.5.5.rc1 2008-03-23 11:36:38 +01:00
parsing.c Merge branch 'stable' 2007-12-02 22:28:37 +01:00
README Update README 2007-09-04 11:53:54 +02:00
shared.c Use GIT-1.5.4.rc4 2008-01-21 08:52:09 +01:00
ui-blob.c Add support for downloading single blobs 2007-05-09 00:48:09 +02:00
ui-commit.c Fix html error detected by test-suite 2007-11-11 13:04:28 +01:00
ui-diff.c Fix html error detected by test-suite 2007-11-11 13:04:28 +01:00
ui-log.c Fix html error detected by test-suite 2007-11-11 13:04:28 +01:00
ui-patch.c Fix segfault in patch view for root commit 2008-03-17 23:51:47 +01:00
ui-refs.c Add support for refs view 2007-10-27 10:53:27 +02:00
ui-repolist.c Fix html error detected by test-suite 2007-11-11 13:04:28 +01:00
ui-shared.c Add plain patch view 2007-12-11 02:43:24 +01:00
ui-snapshot.c Compare string lengths when parsing the snapshot mask 2007-12-03 00:39:20 +01:00
ui-summary.c Fix html error detected by test-suite 2007-11-11 13:04:28 +01:00
ui-tag.c Make ui-tag.c generate valid xhtml 2007-07-23 01:42:49 +02:00
ui-tree.c Fix html error detected by test-suite 2007-11-11 13:04:28 +01: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

Building cgit involves building a proper version of git. How to do this
depends on how you obtained the cgit sources:

a) If you're working in a cloned cgit repository, you first need to
initialize and update the git submodule:

  $ git submodule init     # register the git submodule in .git/config
  $ $EDITOR .git/config    # if you want to specify a different url for git
  $ git submodule update   # clone/fetch and checkout correct git version

b) If you're building from a cgit tarball, you can download a proper git
version like this:

  $ make get-git


When either a) or b) has been performed, you can build and install cgit like
this:

  $ make
  $ sudo make install

This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit". You can
configure this location (and a few other things) by providing a "cgit.conf"
file (see the Makefile for details).


Dependencies:
  -git 1.5.3
  -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 missing 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.

* Branch- and tag-lists in the summary page can get very long, they should
  probably only show something like the ten "latest modified" branches and
  a similar number of "most recent" tags.

* There should be a new page for browsing refs/heads and refs/tags, with links
  from the summary page whenever the branch/tag lists overflow.

* The log-page should have more/better search options (author, committer,
  pickaxe, paths) and possibly support arbitrary revision specifiers.

* A set of test-scripts is required before cgit-1.0 can be released.

Patches/bugreports/suggestions/comments are always welcome, please feel free
to contact the author: hjemli@gmail.com