mirrors/cgit
0
0
Fork 0
mirror of https://git.zx2c4.com/cgit synced 2024-12-25 08:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
A hyperfast web frontend for git repositories written in C.
76 Commits 18 Branches 43 Tags 9.5 MiB
C 73.5%
Shell 8.6%
Lua 7.7%
CSS 3.9%
Python 3.1%
Other 3.2%
c52e84135e
Go to file
Lars Hjemli c52e84135e Add support for prefix and gitsrc arguments to 'make' 
This should improve the installation a little, especially since the new
options are mentioned in the README. Also, add a make-rule to build the
git binaries if necessary + a dependency between cgit and libgit.a.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-02-05 00:12:04 +01:00
.gitignore Add caching infrastructure 2006-12-10 22:31:36 +01:00
cache.c Remove troublesome chars from cachefile names 2007-01-12 00:24:35 +01:00
cgit.c Read repo-info from /etc/cgitrc 2007-02-04 21:47:46 +01:00
cgit.css Set explicit font size 2007-01-28 12:01:21 +01:00
cgit.h Read repo-info from /etc/cgitrc 2007-02-04 21:47:46 +01:00
cgitrc Update cgitrc template 2007-02-04 23:24:08 +01:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
git.h Add support for lightweight tags 2007-02-04 22:55:19 +01:00
html.c Add generic support for search box in page header 2006-12-28 02:01:49 +01:00
Makefile Add support for prefix and gitsrc arguments to 'make' 2007-02-05 00:12:04 +01:00
parsing.c Do not die if tag has no message 2007-02-04 21:21:46 +01:00
README Add support for prefix and gitsrc arguments to 'make' 2007-02-05 00:12:04 +01:00
shared.c Read repo-info from /etc/cgitrc 2007-02-04 21:47:46 +01:00
ui-commit.c Add missing diff-link in ui-commit.c 2006-12-22 01:38:37 +01:00
ui-diff.c Add basic diff view 2006-12-20 22:48:27 +01:00
ui-log.c Add parameter to adjust max message length in log listings 2007-01-28 12:17:03 +01:00
ui-repolist.c Read repo-info from /etc/cgitrc 2007-02-04 21:47:46 +01:00
ui-shared.c Fix search for non-virtual urls 2007-02-03 13:10:26 +01:00
ui-summary.c Add support for lightweight tags 2007-02-04 22:55:19 +01:00
ui-tree.c Cleanup table listings 2007-01-28 00:52:41 +01:00
ui-view.c Cleanup table listings 2007-01-28 00:52:41 +01:00
xdiff.h Add basic diff view 2006-12-20 22:48:27 +01:00

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

  $ make gitsrc=<path>
  $ su
  $ make prefix=<path> install


Default value for gitsrc is "../git", and this directory should contain the
git sources.

Default value for prefix is "/var/www/htdocs/cgit". This directory will 
contain "cgit.cgi" and "cgit.css" after 'make install'.

After installation, httpd.conf probably must be updated with a Directory-
section 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".