mirrors/cgit
0
0
Fork 0
mirror of https://git.zx2c4.com/cgit synced 2024-11-09 10:08:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
A hyperfast web frontend for git repositories written in C.
203 Commits 17 Branches 43 Tags 9.5 MiB
C 73.5%
Shell 8.6%
Lua 7.7%
CSS 3.9%
Python 3.1%
Other 3.2%
e8920b5262
Go to file
Lars Hjemli e8920b5262 Rewrite the makefile + gen-version.sh 
The old files were simply broken, hopefully the new ones will work out
somewhat better.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2007-09-03 22:17:04 +02:00
git@aba170cdb4 Use git-1.5.2 2007-05-20 13:41:05 +02:00
.gitignore Add version info from git-describe 2007-06-18 10:38:40 +02:00
.gitmodules Add submodules.sh and use it during builds 2007-05-11 11:03:52 +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 allow selective enabling of snapshots 2007-07-21 18:00:53 +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 Add html_include() 2007-05-18 23:56:10 +02:00
Makefile Rewrite the makefile + gen-version.sh 2007-09-03 22:17:04 +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 with submodule build info 2007-05-11 12:13:15 +02:00
shared.c Merge branch 'master' of git://git.klever.net/patchwork/cgit 2007-07-22 23:57:56 +02:00
submodules.sh Add submodules.sh and use it during builds 2007-05-11 11:03:52 +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 Add cgit_diff_link() 2007-06-17 18:12:03 +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 Add support for line number in url fragment 2007-07-23 00:47:18 +02: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
  $ su
  $ make install

This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".

Note: The initial "make" will create a submodule 'git' and clone the git
repository at git://git.kernel.org/pub/scm/git/git.git in it. If you
already have a local git git repository that you want to use as origin
for the submodule, run

  $ git clone -s <path-to-git-repo> git
  $ ./submodules.sh -u

before running "make".


Dependencies

  -git (1.5.2-rc0 or newer, due to git submodule) installed
  -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 mis(sing) 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.


The end.