summaryrefslogtreecommitdiff
path: root/README
blob: 73ec332085cc3afda8023dd805552305c30fc587 (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
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
>René 'Necoro' Neumann5-8/+56 2013-10-19Rename 'login' to 'user'René 'Necoro' Neumann4-5/+5 2013-10-19Autofocus for some formsRené 'Necoro' Neumann3-3/+3 2013-10-19More informational flashesRené 'Necoro' Neumann2-2/+9 2013-10-17Moar fixesRené 'Necoro' Neumann3-3/+3 2013-10-17Fixed too muchRené 'Necoro' Neumann2-2/+2 2013-10-17Fix JSRené 'Necoro' Neumann2-2/+2 2013-10-17Fix nameclash of class arrow in cssRené 'Necoro' Neumann1-2/+2 2013-10-16CSS: Tabs to spacesRené 'Necoro' Neumann1-90/+90 2013-10-16Fix arrowsRené 'Necoro' Neumann2-15/+13 2013-10-16Fix locale support for formsRené 'Necoro' Neumann1-2/+11 2013-10-16Use german locale for formsRené 'Necoro' Neumann1-0/+1 2013-10-16Allow @templated to be called raw, i.e. w/o ()René 'Necoro' Neumann5-10/+20 2013-10-16Category names do not need to be uniqueRené 'Necoro' Neumann1-1/+1 2013-10-16Forgot two places where to show flashes on validation errorsRené 'Necoro' Neumann2-3/+3 2013-10-16Do not print 'logout' menu when not logged inRené 'Necoro' Neumann2-4/+6 2013-10-16Check user's authorisation when loading entries by ID.René 'Necoro' Neumann4-6/+43 2013-10-16Print username or description in titleRené 'Necoro' Neumann3-2/+5 2013-10-15QuotestyleRené 'Necoro' Neumann11-86/+88 2013-10-15Flash on error in all formsRené 'Necoro' Neumann2-5/+21 2013-10-15Streamline CSSRené 'Necoro' Neumann2-77/+24 2013-10-15Margin for buttons in formsRené 'Necoro' Neumann1-0/+3 2013-10-15Support flashingRené 'Necoro' Neumann5-2/+34 2013-10-15Moved user implementation from model to loginRené 'Necoro' Neumann3-28/+13 2013-10-15Nicer organised importsRené 'Necoro' Neumann6-24/+40 2013-10-14Finish login stuffRené 'Necoro' Neumann11-29/+143 2013-10-14More model tuningRené 'Necoro' Neumann1-3/+3 2013-10-14Add User to modelRené 'Necoro' Neumann1-8/+25 2013-09-30Add first API stuff -- SingleExpense and CategoryRené 'Necoro' Neumann2-1/+13 2013-09-30Force python2René 'Necoro' Neumann1-1/+1 2013-09-24More margin at the bottom for expense listingRené 'Necoro' Neumann1-1/+1 2013-09-24Better pie formattingRené 'Necoro' Neumann3-6/+8 2013-09-24Increase width of page to 760pxRené 'Necoro' Neumann3-8/+9 2013-09-16typoRené 'Necoro' Neumann1-1/+1 2013-09-15Fix display of one monthRené 'Necoro' Neumann1-2/+2 2013-09-14Draw pies using highcharts JS-libRené 'Necoro' Neumann5-20/+99