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 If you'd like to compile without Lua support, you may use:
  36
  37     $ make NO_LUA=1
  38
  39 And if you'd like to specify a Lua implementation, you may use:
  40
  41     $ make LUA_IMPLEMENTATION=JIT
  42
  43 for using the LuaJIT project. Or:
  44
  45     $ make LUA_IMPLEMENTATION=VANILLA
  46
  47 for the mainline Lua project. If you specify neither implementation, it will
  48 be auto-detected, preferring LuaJIT if both are present.
  49
  50
  51 Dependencies
  52 ------------
  53
  54 * libzip
  55 * libcrypto (OpenSSL)
  56 * libssl (OpenSSL)
  57 * optional: luajit or lua
  58
  59 Apache configuration
  60 --------------------
  61
  62 A new `Directory` section must probably be added for cgit, possibly something
  63 like this:
  64
  65     <Directory "/var/www/htdocs/cgit/">
  66         AllowOverride None
  67         Options +ExecCGI
  68         Order allow,deny
  69         Allow from all
  70     </Directory>
  71
  72
  73 Runtime configuration
  74 ---------------------
  75
  76 The file `/etc/cgitrc` is read by cgit before handling a request. In addition
  77 to runtime parameters, this file may also contain a list of repositories
  78 displayed by cgit (see `cgitrc.5.txt` for further details).
  79
  80 The cache
  81 ---------
  82
  83 When cgit is invoked it looks for a cache file matching the request and
  84 returns it to the client. If no such cache file exists (or if it has expired),
  85 the content for the request is written into the proper cache file before the
  86 file is returned.
  87
  88 If the cache file has expired but cgit is unable to obtain a lock for it, the
  89 stale cache file is returned to the client. This is done to favour page
  90 throughput over page freshness.
  91
  92 The generated content contains the complete response to the client, including
  93 the HTTP headers `Modified` and `Expires`.
  94
  95 Online presence
  96 ---------------
  97
  98 * The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>
  99
 100 * Patches, bug reports, discussions and support should go to the cgit
 101   mailing list: <cgit@lists.zx2c4.com>. To sign up, visit
 102   <http://lists.zx2c4.com/mailman/listinfo/cgit>