cgit with patches for sandboxing using qssb
Go to file
Michael Krelin 7921572fb1 fixed typo in cgitrc
Signed-off-by: Michael Krelin <hacker@klever.net>
2007-09-14 19:28:09 +02:00
git@5587cac28b cgit v0.6.1 2007-09-08 15:54:28 +02:00
.gitignore Add version info from git-describe 2007-06-18 10:38:40 +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 cgit_print_snapshot_links: use url to specify snapshot name 2007-07-23 00:27:32 +02:00
cgit.css Add support for line number in url fragment 2007-07-23 00:47:18 +02:00
cgit.h cgit_print_snapshot_links: use url to specify snapshot name 2007-07-23 00:27:32 +02:00
cgitrc fixed typo in cgitrc 2007-09-14 19:28:09 +02:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
gen-version.sh Rewrite the makefile + gen-version.sh 2007-09-03 22:17:04 +02:00
html.c Rename dirlink to gitlink. 2007-06-04 19:58:32 +02:00
Makefile cgit v0.6.2 2007-09-08 19:10:37 +02:00
parsing.c Add trim_end() and use it to remove trailing slashes from repo paths 2007-06-26 18:04:39 +02:00
README Update README 2007-09-04 11:53:54 +02:00
shared.c Make cgit honor CACHE_ROOT as defined in Makefile 2007-09-08 11:53:40 +02:00
ui-blob.c Add support for downloading single blobs 2007-05-09 00:48:09 +02:00
ui-commit.c cgit_print_snapshot_links: use url to specify snapshot name 2007-07-23 00:27:32 +02:00
ui-diff.c Merge branch 'jo/dirlink' 2007-09-03 23:00:06 +02:00
ui-log.c Add ofs argument to cgit_log_link and use it in ui-log.c 2007-06-29 20:31:00 +02:00
ui-repolist.c Add ofs argument to cgit_log_link and use it in ui-log.c 2007-06-29 20:31:00 +02:00
ui-shared.c cgit_print_snapshot_links: use url to specify snapshot name 2007-07-23 00:27:32 +02:00
ui-snapshot.c ui-snapshot: whitespace/formatting cleanup 2007-07-23 23:12:11 +02:00
ui-summary.c Add ui-tag.c 2007-07-22 23:44:57 +02:00
ui-tag.c Make ui-tag.c generate valid xhtml 2007-07-23 01:42:49 +02:00
ui-tree.c Merge branch 'jo/dirlink' 2007-09-03 23:00:06 +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

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