about summary refs log tree commit diff
path: root/README
blob: 73ec332085cc3afda8023dd805552305c30fc587 (plain) (blame)
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

                       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
tgraph'>| * Clean up klonJune McEnroe2018-02-25 | * Clean up xxJune McEnroe2018-02-23 | | | | There are probably like 12 commits with this title. * Clean up wakeJune McEnroe2018-02-23 | * Avoid unnecessary FDs in errorsJune McEnroe2018-02-23 | * Clean up pbdJune McEnroe2018-02-23 | | | | Seems probably a good idea to CLOEXEC sockets. * Clean up fbclockJune McEnroe2018-02-23 | | | | | | | You can't use the return value of gzerror to check if an error occurred or not. Its implementation actually checks if the internal error is NULL and returns the empty string if it is! This is stupid and unhelpful, so check gzeof first since its return value actually means something. * Don't bother checking result of close(2) in dtchJune McEnroe2018-02-23 | * Tweak fbatt exit codesJune McEnroe2018-02-23 | * Clean up dtch (again, probably)June McEnroe2018-02-23 | | | | | Mostly changes to exit codes and renaming len to size. Also no more writeAll. * Return NOINPUT on execvp failureJune McEnroe2018-02-23 | * Return EX_OSFILE in briJune McEnroe2018-02-23 | * Rewrite briJune McEnroe2018-02-22 | * Exit cleanly from hnel on LinuxJune McEnroe2018-02-22 | | | | Okay the change that actually does that is checking revents == POLLIN. * Abort on other values of enums in pngoJune McEnroe2018-02-22 | * Fix zlib types on 32-bitJune McEnroe2018-02-22 | * Add unistd.h include to pngo.cJune McEnroe2018-02-20 | | | | Where getopt properly lives. * Take multiple inputs to pngoJune McEnroe2018-02-20 | * Reduce bit depth in pngoJune McEnroe2018-02-20 | * Always use None filter for indexed or bit depth < 8