Diffstat (limited to 'README')
| -rw-r--r-- | README | 114 |
1 files changed, 25 insertions, 89 deletions
@@ -1,99 +1,35 @@ -cgit - CGI for Git -================== -This is an attempt to create a fast web interface for the Git SCM, using a -built-in cache to decrease server I/O pressure. + cgit - cgi for git -Installation ------------- -Building cgit involves building a proper version of Git. How to do this -depends on how you obtained the cgit sources: +This is an attempt to create a fast web interface for the git scm, using a +frontside cache to decrease server io-pressure. -a) If you're working in a cloned cgit repository, you first need to -initialize and update the Git submodule: +When cgit is invoked, it looks for a cached page matching the request. If no +such cachefile exist (or it has expired), it is (re)generated. Finally, the +cachefile is returned to the client. - $ 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). - -If you'd like to compile without Lua support, you may use: - - $ make NO_LUA=1 - -And if you'd like to specify a Lua implementation, you may use: - - $ make LUA_PKGCONFIG=lua5.1 - -If this is not specified, the Lua implementation will be auto-detected, -preferring LuaJIT if many are present. Acceptable values are generally "lua", -"luajit", "lua5.1", and "lua5.2". - - -Dependencies ------------- - -* libzip -* libcrypto (OpenSSL) -* libssl (OpenSSL) -* optional: luajit or lua, most reliably used when pkg-config is available - -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 may also contain a list of repositories -displayed by cgit (see `cgitrc.5.txt` for further details). - -The cache ---------- - -When cgit is invoked it looks for a cache file matching the request and -returns it to the client. If no such cache file exists (or if it has expired), -the content for the request is written into the proper cache file before the -file is returned. - -If the cache file has expired but cgit is unable to obtain a lock for it, the -stale cache file is returned to the client. This is done to favour page +If the cachefile has expired, but cgit is unable to lock the cachefile, the +client will get the stale cachefile after all. 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`. +Also, when a cachefile is generated, a few cache-related http-headers are +created: "Modified" is set to current time(2), while "Expires" is set to +time(2) + <cachefile TTL> * 60 (unless the TTL is negative, in which case it +is read as "60 * 60 * 24 * 365"). This is done to avoid repeated requests for +already visited pages. + +The following cache-related options can be set in /etc/cgitrc: -Online presence ---------------- + cache-root=<path> root directory for cache files + cache-root-ttl=<min> TTL for the repo listing page + cache-repo-ttl=<min> TTL for repo summary pages + cache-dynamic-ttl=<min> TTL for pages with symbolic references + cache-static-ttl=<min> TTL for pages with sha1 references -* The cgit homepage is hosted by cgit at <https://git.zx2c4.com/cgit/about/> +The cachefiles are split into different directories, based on the requested +repository and page: -* Patches, bug reports, discussions and support should go to the cgit - mailing list: <cgit@lists.zx2c4.com>. To sign up, visit - <https://lists.zx2c4.com/mailman/listinfo/cgit> + Repo listing: <cachedir>/index.html + Repo summary: <cachedir>/<repo>/index.html + Repo subpage: <cachedir>/<repo>/<page>/<querystring>.html |