cgit with patches for sandboxing using qssb
Iet uz failu
Lars Hjemli dcef257d4f Remove implementation details from README
Let README describe the "bigger picture" instead.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-13 02:06:29 +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 Add display of tree content w/ui-tree.c 2006-12-13 00:13:27 +01:00
README Remove implementation details from README 2006-12-13 02:06:29 +01:00
cache.c cache_lock: do xstrdup/free on lockfile 2006-12-12 10:16:41 +01:00
cgit.c Add display of tree content w/ui-tree.c 2006-12-13 00:13:27 +01:00
cgit.css Small layout adjustments to summary and blob view 2006-12-13 00:36:22 +01:00
cgit.h Add display of tree content w/ui-tree.c 2006-12-13 00:13:27 +01:00
git.h Add display of tree content w/ui-tree.c 2006-12-13 00:13:27 +01:00
html.c Add license file and copyright notices 2006-12-10 22:41:14 +01:00
parsing.c Rename config.c to parsing.c + move cgit_parse_query from cgit.c to parsing.c 2006-12-11 16:11:40 +01:00
shared.c Move global variables + callback functions into shared.c 2006-12-11 17:25:51 +01:00
ui-log.c Add display of tree content w/ui-tree.c 2006-12-13 00:13:27 +01:00
ui-repolist.c Move functions for repolist output into ui-repolist.c 2006-12-11 16:49:18 +01:00
ui-shared.c Move functions for repolist output into ui-repolist.c 2006-12-11 16:49:18 +01:00
ui-summary.c Small layout adjustments to summary and blob view 2006-12-13 00:36:22 +01:00
ui-tree.c Add display of tree content w/ui-tree.c 2006-12-13 00:13:27 +01:00
ui-view.c Small layout adjustments to summary and blob view 2006-12-13 00:36:22 +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