README

   1
   2                        cgit - cgi for git
   3
   4
   5 This is an attempt to create a fast web interface for the git scm, using a
   6 builtin cache to decrease server io-pressure.
   7
   8
   9 Installation
  10
  11   $ make
  12   $ su
  13   $ make install
  14
  15 This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit".
  16
  17 Note: The initial "make" will create a submodule 'git' and clone the git
  18 repository at git://git.kernel.org/pub/scm/git/git.git in it. If you
  19 already have a local git git repository that you want to use as origin
  20 for the submodule, run
  21
  22   $ git clone -s <path-to-git-repo> git
  23   $ ./submodules.sh -u
  24
  25 before running "make".
  26
  27
  28 Dependencies
  29
  30   -git (1.5.2-rc0 or newer, due to git submodule) installed
  31   -zip lib
  32   -crypto lib
  33   -openssl lib
  34
  35
  36 Apache configuration
  37
  38 A new Directory-section must probably be added for cgit, possibly something
  39 like this:
  40
  41   <Directory "/var/www/htdocs/cgit/">
  42       AllowOverride None
  43       Options ExecCGI
  44       Order allow,deny
  45       Allow from all
  46   </Directory>
  47
  48
  49 Runtime configuration
  50
  51 The file /etc/cgitrc is read by cgit before handling a request. In addition
  52 to runtime parameters, this file also contains a list of the repositories
  53 displayed by cgit.
  54
  55 A template cgitrc is shipped with the sources, and all parameters and default
  56 values are documented in this file.
  57
  58
  59 The cache
  60
  61 When cgit is invoked it looks for a cachefile matching the request and
  62 returns it to the client. If no such cachefile exist (or if it has expired),
  63 the content for the request is written into the proper cachefile before the
  64 file is returned.
  65
  66 If the cachefile has expired but cgit is unable to obtain a lock for it, the
  67 stale cachefile is returned to the client. This is done to favour page
  68 throughput over page freshness.
  69
  70 The generated content contains the complete response to the client, including
  71 the http-headers "Modified" and "Expires".
  72
  73
  74 The mis(sing) features
  75
  76 Submodule links in the directory listing page have a fixed format per
  77 repository. This should probably be extended to a generic map between
  78 submodule path and url.
  79
  80
  81 The end.