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 06c81d6faa Add some more decls from git (cache.h, tag.h)
This is in preparation for extended tag support in cgit

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 cgit 0.1 18 years ago
README Remove implementation details from README 18 years ago
cache.c Remove troublesome chars from cachefile names 18 years ago
cgit.c WIP: add paths/backlinks to tree/blobview 18 years ago
cgit.css Add generic support for search box in page header 18 years ago
cgit.h WIP: add paths/backlinks to tree/blobview 18 years ago
git.h Add some more decls from git (cache.h, tag.h) 18 years ago
html.c Add generic support for search box in page header 18 years ago
parsing.c Handle empty/malformed commit messages 18 years ago
shared.c WIP: add paths/backlinks to tree/blobview 18 years ago
ui-commit.c Add missing diff-link in ui-commit.c 18 years ago
ui-diff.c Add basic diff view 18 years ago
ui-log.c Add basic log filtering 18 years ago
ui-repolist.c Add generic support for search box in page header 18 years ago
ui-shared.c Use long instead of int when converting from TTL to seconds 18 years ago
ui-summary.c Only show first 80 characters of commit subject in log and summary 18 years ago
ui-tree.c WIP: add paths/backlinks to tree/blobview 18 years ago
ui-view.c Add ui-commit.c + misc ui cleanups 18 years ago
xdiff.h Add basic diff 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