You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Lars Hjemli dcef257d4f Remove implementation details from README
Let README describe the "bigger picture" instead.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
18 years ago
.gitignore Add caching infrastructure 18 years ago
COPYING Add license file and copyright notices 18 years ago
Makefile Add display of tree content w/ui-tree.c 18 years ago
README Remove implementation details from README 18 years ago
cache.c cache_lock: do xstrdup/free on lockfile 18 years ago
cgit.c Add display of tree content w/ui-tree.c 18 years ago
cgit.css Small layout adjustments to summary and blob view 18 years ago
cgit.h Add display of tree content w/ui-tree.c 18 years ago
git.h Add display of tree content w/ui-tree.c 18 years ago
html.c Add license file and copyright notices 18 years ago
parsing.c Rename config.c to parsing.c + move cgit_parse_query from cgit.c to parsing.c 18 years ago
shared.c Move global variables + callback functions into shared.c 18 years ago
ui-log.c Add display of tree content w/ui-tree.c 18 years ago
ui-repolist.c Move functions for repolist output into ui-repolist.c 18 years ago
ui-shared.c Move functions for repolist output into ui-repolist.c 18 years ago
ui-summary.c Small layout adjustments to summary and blob view 18 years ago
ui-tree.c Add display of tree content w/ui-tree.c 18 years ago
ui-view.c Small layout adjustments to summary and blob view 18 years ago

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