mirrors/cgit
0
0
Fork 0
mirror of https://git.zx2c4.com/cgit synced 2024-12-22 23:21:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
A hyperfast web frontend for git repositories written in C.
31 Commits 18 Branches 43 Tags 9.5 MiB
C 73.5%
Shell 8.6%
Lua 7.7%
CSS 3.9%
Python 3.1%
Other 3.2%
521dc7a4bf
Go to file
Lars Hjemli 521dc7a4bf Add argument parsing + switch for uncached operation 
This adds support for the following options to cgit:
  --root=<path>
  --cache=<path>
  --nocache
  --query=<querystring>
  --repo=<reponame>
  --page=<pagename>
  --head=<branchname>
  --sha1=<sha1>
  --ofs=<number>

On startup, /etc/cgitrc is parsed, followed by argument parsing and
finally querystring parsing.

If --nocache is specified (or set in /etc/gitrc), caching is disabled and
cgit instead generates pages to stdout.

The combined effect of these two changes makes testing/debugging a lot
less painfull.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
2006-12-16 13:38:45 +01:00
.gitignore Add caching infrastructure 2006-12-10 22:31:36 +01:00
cache.c cache_lock: do xstrdup/free on lockfile 2006-12-12 10:16:41 +01:00
cgit.c Add argument parsing + switch for uncached operation 2006-12-16 13:38:45 +01:00
cgit.css gitweb ripoff: set tr:hover to highligt current row 2006-12-16 01:05:58 +01:00
cgit.h Add argument parsing + switch for uncached operation 2006-12-16 13:38:45 +01:00
COPYING Add license file and copyright notices 2006-12-10 22:41:14 +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
Makefile Add ui-commit.c + misc ui cleanups 2006-12-16 00:19:56 +01:00
parsing.c Add ui-commit.c + misc ui cleanups 2006-12-16 00:19:56 +01:00
README Remove implementation details from README 2006-12-13 02:06:29 +01:00
shared.c Add argument parsing + switch for uncached operation 2006-12-16 13:38:45 +01:00
ui-commit.c Add head comment to ui-commit.c 2006-12-16 01:11:55 +01:00
ui-log.c Add ui-commit.c + misc ui cleanups 2006-12-16 00:19:56 +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 Make repo header a link to summary page 2006-12-16 00:49:37 +01:00
ui-summary.c Move cgit_print_date into ui-shared, reuse in ui-summary 2006-12-16 00:33:28 +01:00
ui-tree.c Add ui-commit.c + misc ui cleanups 2006-12-16 00:19:56 +01:00
ui-view.c Add ui-commit.c + misc ui cleanups 2006-12-16 00:19:56 +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