A hyperfast web frontend for git repositories written in C.
Go to file
2009-12-08 19:34:30 +01:00
filters syntax highlighting for all formats supported by "highlight" 2009-11-19 12:14:45 +01:00
git@7fb6bcff2d Use GIT-1.6.4.3 2009-09-13 21:56:45 +02:00
tests Merge branch 'jw/commit-decorations' 2009-01-27 23:00:40 +01:00
.gitignore Fix doc-related glitches in Makefile and .gitignore 2009-03-15 09:27:54 +01:00
.gitmodules Delete submodules.sh and prepare for using git-submodule 2007-09-03 22:54:51 +02:00
cache.c Fix some warnings to allow -Werror 2008-11-06 19:18:07 +01:00
cache.h cache.h: export hash_str() 2009-08-24 10:22:57 +02:00
cgit-doc.css Add cgit-doc.css 2009-02-12 10:24:25 +01:00
cgit.c Merge branch 'lh/remote-branches' 2009-12-08 19:34:30 +01:00
cgit.css Merge branch 'ro/ssdiff' 2009-12-08 19:32:48 +01:00
cgit.h Merge branch 'lh/remote-branches' 2009-12-08 19:34:30 +01:00
cgit.png Replace sidebar/logo 2008-04-12 20:00:27 +02:00
cgitrc.5.txt Merge branch 'lh/remote-branches' 2009-12-08 19:34:30 +01:00
cmd.c ui-summary: enable arbitrary paths below repo.readme 2009-08-09 13:41:54 +02:00
cmd.h Add command dispatcher 2008-03-24 01:43:48 +01:00
configfile.c Move function for configfile parsing into configfile.[ch] 2008-03-28 00:09:11 +01:00
configfile.h Move function for configfile parsing into configfile.[ch] 2008-03-28 00:09:11 +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 html.c: use correct escaping in html attributes 2009-01-29 22:21:15 +01:00
html.h html.c: add html_url_path 2008-10-05 16:52:57 +02:00
Makefile Merge branch 'ro/ssdiff' 2009-12-08 19:32:48 +01:00
parsing.c parsing.c: enable builds with NO_ICONV defined 2008-12-05 19:10:28 +01:00
README Update README 2007-09-04 11:53:54 +02:00
scan-tree.c Add support for repo-local cgitrc file 2009-08-24 10:22:58 +02:00
scan-tree.h Add support for repo-local cgitrc file 2009-08-24 10:22:58 +02:00
shared.c Add support for remote branches 2009-11-07 19:10:58 +01:00
ui-atom.c Introduce noplainemail option to hide email adresses from spambots 2009-08-08 14:23:28 +02:00
ui-atom.h Add atom-support 2008-08-01 22:12:34 +02:00
ui-blob.c ui-blob: return 'application/octet-stream' for binary blobs 2009-07-25 11:51:19 +02:00
ui-blob.h allow blob extract blobs by head/path combination 2008-06-24 23:33:24 +02:00
ui-clone.c Supply status description to html_status() 2008-08-06 22:57:44 +02:00
ui-clone.h Add support for cloning over http 2008-08-06 11:21:09 +02:00
ui-commit.c Add possibility to switch between unidiff and side-by-side-diff. 2009-09-16 20:17:56 +02:00
ui-commit.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-diff.c Fixed side-by-side diff bugs related to binary diff and more. 2009-09-16 20:17:56 +02:00
ui-diff.h Integrate diffstat with diff 2008-04-24 23:41:32 +02:00
ui-log.c Add possibility to switch between unidiff and side-by-side-diff. 2009-09-16 20:17:56 +02:00
ui-log.h Add decorations to commit pages 2009-01-27 22:45:47 +01:00
ui-patch.c Introduce noplainemail option to hide email adresses from spambots 2009-08-08 14:23:28 +02:00
ui-patch.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-plain.c Merge branch 'stable' 2009-09-06 19:33:27 +02:00
ui-plain.h Implement plain view 2008-08-06 11:21:30 +02:00
ui-refs.c Merge branch 'lh/remote-branches' 2009-12-08 19:34:30 +01:00
ui-refs.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-repolist.c Fix repolist search links with virtual root 2009-09-20 13:07:57 +02:00
ui-repolist.h Prepare for 'about site' page / add 'root-readme' option to cgitrc 2008-04-29 01:06:30 +02:00
ui-shared.c Merge branch 'ro/ssdiff' 2009-12-08 19:32:48 +01:00
ui-shared.h Merge branch 'ro/ssdiff' 2009-12-08 19:32:48 +01:00
ui-snapshot.c ui-snapshot: use cgit_{open|close}_filter() to execute compressors 2009-07-31 17:40:13 +02:00
ui-snapshot.h Set prefix in snapshots when using dwimmery 2008-11-30 13:39:53 +01:00
ui-ssdiff.c In side-by-side diff, add support for marking individual characters. 2009-11-07 15:37:11 +01:00
ui-ssdiff.h Polishing of how the side-by-side diff looks. 2009-09-16 20:17:56 +02:00
ui-stats.c Add and use cgit_find_stats_periodname() in print_repo() 2009-08-24 11:02:48 +02:00
ui-stats.h Add and use cgit_find_stats_periodname() in print_repo() 2009-08-24 11:02:48 +02:00
ui-summary.c Add 'about-filter' and 'repo.about-filter' options 2009-08-09 13:41:54 +02:00
ui-summary.h ui-summary: enable arbitrary paths below repo.readme 2009-08-09 13:41:54 +02:00
ui-tag.c ui-tag: make output more similar to commit view 2009-10-06 20:33:04 +02:00
ui-tag.h Add separate header-files for each page/view 2008-03-24 16:38:47 +01:00
ui-tree.c "max-blob-size" config var to limit generated HTML size 2009-11-28 03:44:33 +01:00
ui-tree.h Add separate header-files for each page/view 2008-03-24 16:38:47 +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