Skip to content
a fast web interface for git http://hjemli.net/git/cgit/
C Shell
Find file
Failed to load latest commit information.
git @ 031e6c8 Use GIT-1.6.0.3
tests Fix tests to work on Ubuntu (dash)
.gitignore Makefile: autobuild dependency rules
.gitmodules Delete submodules.sh and prepare for using git-submodule
COPYING Add license file and copyright notices
Makefile Use mode 0644 for non-executable files
README Update README
cache.c Fix some warnings to allow -Werror
cache.h Add page 'ls_cache'
cgit.c Make virtual-root work with pretty urls.
cgit.css Add link to index page from repo header, remove page name
cgit.h Add cgit_query.nohead flag
cgit.png Replace sidebar/logo
cgitrc.5.txt Replace cgitrc with cgitrc.5.txt
cmd.c ui-snapshot: add dwimmery
cmd.h Add command dispatcher
configfile.c Move function for configfile parsing into configfile.[ch]
configfile.h Move function for configfile parsing into configfile.[ch]
gen-version.sh gen-version.sh: don't sed the output from git describe
html.c html.c: add html_url_path
html.h html.c: add html_url_path
parsing.c parsing.c: be prepared for unexpected content in commit/tag objects
scan-tree.c Add support for --scan-tree=<path> option to cgit
scan-tree.h Add support for --scan-tree=<path> option to cgit
shared.c Move cgit_parse_query() from parsing.c to html.c as http_parse_querys…
ui-atom.c Add atom-support
ui-atom.h Add atom-support
ui-blob.c Adjust to new calling convention for read_tree_recursive()
ui-blob.h allow blob extract blobs by head/path combination
ui-clone.c Supply status description to html_status()
ui-clone.h Add support for cloning over http
ui-commit.c Added `local-time` option to cgitrc
ui-commit.h Add separate header-files for each page/view
ui-diff.c ui-diff: make diffstat header a link to the full diff
ui-diff.h Integrate diffstat with diff
ui-log.c Use GIT-1.6.0.2
ui-log.h Add separate header-files for each page/view
ui-patch.c Added `local-time` option to cgitrc
ui-patch.h Add separate header-files for each page/view
ui-plain.c Fix some warnings to allow -Werror
ui-plain.h Implement plain view
ui-refs.c ui-refs: use cgit_tag_link()
ui-refs.h Add separate header-files for each page/view
ui-repolist.c ui-repolist: handle empty agefiles
ui-repolist.h Prepare for 'about site' page / add 'root-readme' option to cgitrc
ui-shared.c ui-shared: specify correct css class for summary tab
ui-shared.h ui-shared: add cgit_tag_link()
ui-snapshot.c ui-snapshot: add dwimmery
ui-snapshot.h ui-snapshot: add dwimmery
ui-summary.c ui-summary: use html_url_path()
ui-summary.h Prepare for 'about repo' page
ui-tag.c ui-tag: show the taggers email
ui-tag.h Add separate header-files for each page/view
ui-tree.c ui-tree: link to plain view instead of blob view
ui-tree.h Add separate header-files for each page/view

README

                       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
Something went wrong with that request. Please try again.