summaryrefslogtreecommitdiff
path: root/README
blob: a14418e8db8af0e239b524a0f37505e94f9993ba (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
                       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".
......)René 'Necoro' Neumann2-3/+3 2023-09-20Bump goreleaser/goreleaser-action from 4 to 5dependabot[bot]1-1/+1 2023-09-15Go 1.21René 'Necoro' Neumann2-8/+2 2023-09-15Upgrade dependenciesRené 'Necoro' Neumann2-17/+20 2023-09-15Bump github.com/antonmedv/expr from 1.14.0 to 1.15.1dependabot[bot]2-8/+4 2023-09-15Bump actions/checkout from 3 to 4dependabot[bot]2-2/+2 2023-08-26Bump golang.org/x/net from 0.12.0 to 0.14.0dependabot[bot]2-6/+6 2023-08-26Bump github.com/antonmedv/expr from 1.12.6 to 1.14.0dependabot[bot]2-3/+3 2023-07-15Upgrade depsRené 'Necoro' Neumann2-15/+12 2023-06-13Version Changelog entryv1.7.0René 'Necoro' Neumann1-1/+4 2023-06-13Prepare v1.7.0René 'Necoro' Neumann2-2/+2 2023-06-05Improve changelogRené 'Necoro' Neumann1-2/+4 2023-06-05IMAP client does not need to know about max number of connectionsRené 'Necoro' Neumann2-19/+12 2023-06-04ChangelogRené 'Necoro' Neumann1-0/+4 2023-06-04Add new config option to set max number of IMAP connections.René 'Necoro' Neumann5-20/+26 2023-06-04Improve locking around IMAP connect/disconnect.René 'Necoro' Neumann1-10/+26 2023-05-20Bump golang.org/x/net from 0.9.0 to 0.10.0dependabot[bot]2-2/+3 2023-05-12Amend changelogRené 'Necoro' Neumann1-0/+1 2023-05-12Issue #95 Add warning when config can be read globally.René 'Necoro' Neumann1-0/+11 2023-05-11Issue #95: Change cache ownership.René 'Necoro' Neumann1-0/+4 2023-05-11Issue #95: Add hint about sensible access rights.René 'Necoro' Neumann1-0/+1 2023-04-23[workflow] Port changes also to releaseRené 'Necoro' Neumann1-6/+5 2023-04-23[workflow] Checkout before go setupRené 'Necoro' Neumann1-3/+3 2023-04-23[workflow] determine go version from go.modRené 'Necoro' Neumann1-3/+2 2023-04-23Improve test to also validate error messageRené 'Necoro' Neumann1-42/+39 2023-04-22Fix/improve testsRené 'Necoro' Neumann1-59/+104 2023-04-22Improve error handlingRené 'Necoro' Neumann1-1/+11 2023-04-21Fix workflow: '1.20' needs to be quotedRené 'Necoro' Neumann2-2/+2