README

   1 cgit - CGI for Git
   2 ==================
   3
   4 This is an attempt to create a fast web interface for the Git SCM, using a
   5 built-in cache to decrease server I/O pressure.
   6
   7 Installation
   8 ------------
   9
  10 Building cgit involves building a proper version of Git. How to do this
  11 depends on how you obtained the cgit sources:
  12
  13 a) If you're working in a cloned cgit repository, you first need to
  14 initialize and update the Git submodule:
  15
  16     $ git submodule init     # register the Git submodule in .git/config
  17     $ $EDITOR .git/config    # if you want to specify a different url for git
  18     $ git submodule update   # clone/fetch and checkout correct git version
  19
  20 b) If you're building from a cgit tarball, you can download a proper git
  21 version like this:
  22
  23     $ make get-git
  24
  25 When either a) or b) has been performed, you can build and install cgit like
  26 this:
  27
  28     $ make
  29     $ sudo make install
  30
  31 This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You
  32 can configure this location (and a few other things) by providing a `cgit.conf`
  33 file (see the Makefile for details).
  34
  35 Dependencies
  36 ------------
  37
  38 * libzip
  39 * libcrypto (OpenSSL)
  40 * libssl (OpenSSL)
  41
  42 Apache configuration
  43 --------------------
  44
  45 A new `Directory` section must probably be added for cgit, possibly something
  46 like this:
  47
  48     <Directory "/var/www/htdocs/cgit/">
  49         AllowOverride None
  50         Options +ExecCGI
  51         Order allow,deny
  52         Allow from all
  53     </Directory>
  54
  55
  56 Runtime configuration
  57 ---------------------
  58
  59 The file `/etc/cgitrc` is read by cgit before handling a request. In addition
  60 to runtime parameters, this file may also contain a list of repositories
  61 displayed by cgit (see `cgitrc.5.txt` for further details).
  62
  63 The cache
  64 ---------
  65
  66 When cgit is invoked it looks for a cache file matching the request and
  67 returns it to the client. If no such cache file exists (or if it has expired),
  68 the content for the request is written into the proper cache file before the
  69 file is returned.
  70
  71 If the cache file has expired but cgit is unable to obtain a lock for it, the
  72 stale cache file is returned to the client. This is done to favour page
  73 throughput over page freshness.
  74
  75 The generated content contains the complete response to the client, including
  76 the HTTP headers `Modified` and `Expires`.
  77
  78 Online presence
  79 ---------------
  80
  81 * The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
  82
  83 * Patches, bug reports, discussions and support should go to the cgit
  84   mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
  85   <http://lists.zx2c4.com/mailman/listinfo/cgit>