cgit with patches for sandboxing using qssb
Go to file
Lars Hjemli f98e72684b Use long instead of int when converting from TTL to seconds
Just to be really, really sure about embarrasing overflow settings

Signed-off-by: Lars Hjemli <larsh@hal-2004.(none)>
2007-01-05 18:20:23 +01:00
.gitignore Add caching infrastructure 2006-12-10 22:31:36 +01:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +01:00
Makefile cgit 0.1 2006-12-21 00:53:34 +01:00
README Remove implementation details from README 2006-12-13 02:06:29 +01:00
cache.c Allow relative paths for cgit_cache_root 2006-12-16 13:55:58 +01:00
cgit.c Use TTL-settings even in nocache mode 2007-01-05 18:18:58 +01:00
cgit.css Add generic support for search box in page header 2006-12-28 02:01:49 +01:00
cgit.h Handle %xx encoding in querystring 2007-01-04 16:57:00 +01:00
git.h Add basic log filtering 2006-12-28 02:45:28 +01:00
html.c Add generic support for search box in page header 2006-12-28 02:01:49 +01:00
parsing.c Handle %xx encoding in querystring 2007-01-04 16:57:00 +01:00
shared.c Handle %xx encoding in querystring 2007-01-04 16:57:00 +01:00
ui-commit.c Add missing diff-link in ui-commit.c 2006-12-22 01:38:37 +01:00
ui-diff.c Add basic diff view 2006-12-20 22:48:27 +01:00
ui-log.c Add basic log filtering 2006-12-28 02:45:28 +01:00
ui-repolist.c Add generic support for search box in page header 2006-12-28 02:01:49 +01:00
ui-shared.c Use long instead of int when converting from TTL to seconds 2007-01-05 18:20:23 +01:00
ui-summary.c Only show first 80 characters of commit subject in log and summary 2006-12-22 00:58:18 +01:00
ui-tree.c Use html_filemode in ui-tree.c 2006-12-17 23:55:53 +01:00
ui-view.c Add ui-commit.c + misc ui cleanups 2006-12-16 00:19:56 +01:00
xdiff.h Add basic diff view 2006-12-20 22:48:27 +01:00

README

                       cgit - cgi for git


This is an attempt to create a fast web interface for the git scm, using a 
frontside cache to decrease server io-pressure.

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.

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.

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:

  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 cachefiles are split into different directories, based on the requested
repository and page:

  Repo listing:  <cachedir>/index.html
  Repo summary:  <cachedir>/<repo>/index.html
  Repo subpage:  <cachedir>/<repo>/<page>/<querystring>.html