summaryrefslogtreecommitdiff
path: root/README
blob: 5a7bdf855ec556c917f75a141f3df5dd22b2a983 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
                       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.7.4
  -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 may also contain a list of repositories
displayed by cgit (see cgitrc.5.txt for further details).


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".


Online presence

* The cgit homepage is hosted by cgit at http://hjemli.net/git/cgit/about

* Patches, bugreports, discussions and support should go to the cgit
  mailing list: cgit@hjemli.net
lass='deletions'>-15/+120 2006-10-15Implemented emerge --syncnecoro2-0/+10 2006-10-15First implementation of "emerge --update world"necoro4-17/+100 2006-10-14Wah - I'm tired ...necoro1-3/+3 2006-10-14and now another bug -.-necoro1-2/+2 2006-10-14forgot one returnnecoro1-0/+2 2006-10-14Set min height to 600 if maxHeight is smaller then 800necoro2-4/+7 2006-10-13Some more documentationnecoro2-82/+298 2006-10-13Documentation worknecoro2-154/+160 2006-10-12Enabled oneshotnecoro3-32/+103 2006-10-12Layout updatenecoro1-16/+38 2006-10-12Fixed bugsnecoro2-15/+16 2006-10-12Migrated to UIManagernecoro1-33/+64 2006-10-10Fixed bug not showing the use-flag-list in some casesnecoro1-3/+5 2006-10-09bla - prepared 0.4.0 ; added dialogs.py; extended some commentsnecoro9-125/+293 2006-10-08Made the testing stuff working too ... I hope ^^ ... removed obsolete-dirnecoro7-145/+113 2006-10-05Added first support for the masking stuff ... and hoping that it is going to ↵necoro5-79/+135 work properly ;) 2006-10-05Changed changelog / added config-filenecoro2-0/+10 2006-10-05Added preference windownecoro4-49/+155 2006-10-02Corrected comments, structure, bad algorithms etcnecoro4-176/+209 2006-10-02Corrected indention in commentnecoro1-8/+6 2006-10-010.3.3necoro1-0/+6 2006-10-01Implemented an internal db; removed unmerge-bugnecoro2-26/+43 2006-09-30Implemented some new backend functions which speed up the ↵necoro2-12/+37 package-list-creation. (Thanks an porthole for the inspiration ;P) 2006-09-300.3.2 release; changed font in terminal; added new "masking"-dialognecoro3-11/+36 2006-09-29fixed bugsnecoro4-13/+23 2006-09-29Corrected setup.pynecoro1-1/+1