about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorLars Hjemli <hjemli@gmail.com>2007-01-28 13:18:23 +0100
committerLars Hjemli <hjemli@gmail.com>2007-01-28 13:18:23 +0100
commit66414b68cf30f9ae7613c68833e7cbc8e93adae2 (patch)
tree912eff9ee7e027b8129e6e204ace31926ccc89f4 /README
parentAdd template for /etc/cgitrc (diff)
downloadcgit-pink-66414b68cf30f9ae7613c68833e7cbc8e93adae2.tar.gz
cgit-pink-66414b68cf30f9ae7613c68833e7cbc8e93adae2.zip
Update README with install/config information
Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Diffstat (limited to 'README')
-rw-r--r--README52
1 files changed, 28 insertions, 24 deletions
diff --git a/README b/README
index 010dd5c..17e284e 100644
--- a/README
+++ b/README
@@ -2,34 +2,38 @@
                        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.
+This is an attempt to create a fast web interface for the git scm, using a
+builtin 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.
+Installation
+
+$ $EDITOR Makefile
+$ make
+$ sudo make install
+
+Note: cgit requires the git and xdiff libraries. Currently, the makefile
+expects these files to be found in '../git/libgit.a' and '../git/xdiff/lib.a',
+where they will be if you have built git from source in a parallell directory.
+
 
-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.
+Runtime configuration
 
-The following cache-related options can be set in /etc/cgitrc:
+The file /etc/cgitrc is read by cgit before handling a request. A template 
+cgitrc is shipped with the sources, and all parameters and default values 
+can be found in this file.
 
-  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:
+The cache
+
+When cgit is invoked it looks for a cachefile matching the request and 
+returns it to the client. If no such cachefile exist (or if it has expired), 
+the content for the request is written into the proper cachefile before the
+file is returned.
+
+If the cachefile has expired but cgit is unable to obtain a lock for it, the 
+stale cachefile is returned to the client. This is done to favour page
+throughput over page freshness.
 
-  Repo listing:  <cachedir>/index.html
-  Repo summary:  <cachedir>/<repo>/index.html
-  Repo subpage:  <cachedir>/<repo>/<page>/<querystring>.html
+The generated content contains the complete response to the client, including
+the http-headers "Modified" and "Expires".
@keeping.me.uk> 2014-06-30Bump version.Jason A. Donenfeld 2014-06-29remove debug fprinf() calls that sneaked in with commit 79c985Christian Hesse 2014-06-28git: update to 2.0.1Christian Hesse Everything works just bumping the version in Makefile and commit hash in submodule. No code changes required. 2014-06-28ui-patch: Flush stdout after outputting dataJohn Keeping It looks like cached patches are truncated to the nearest 1024-byte boundary in the patch body. E.g.: > mricon@nikko:[/tmp]$ wget -O no-cache > "http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/patch/?id=6e1b4fdad5157bb9e88777d525704aba24389bee" ... > 2014-06-11 15:34:51 (80.4 MB/s) - ‘no-cache’ saved [4767] Patch is complete, without truncation. Next hit, with cache in place: > mricon@nikko:[/tmp]$ wget -O yes-cache > "http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/patch/?id=6e1b4 > fdad5157bb9e88777d525704aba24389bee" ... > 2014-06-11 15:35:01 (17.0 MB/s) - ‘yes-cache’ saved [4096/4096] Length truncated to 4096. The cache on disk looks truncated as well, so the bug must me during the process of saving cache. The same is true for larger patches: > mricon@nikko:[/tmp]$ wget -O no-cache > "http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/patch/?id=2840c566e95599cd60c7143762ca8b49d9395050" ... > 2014-06-11 15:41:33 (1.07 MB/s) - ‘no-cache’ saved [979644] 979644 bytes with a cache-miss > mricon@nikko:[/tmp]$ wget -O yes-cache > "http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/patch/?id=2840c > 566e95599cd60c7143762ca8b49d9395050" ... > 2014-06-11 15:41:46 (1.05 MB/s) - ‘yes-cache’ saved [978944] 978944 (956KB exactly) with a cache-hit Since the "html" functions use raw write(2) to STDIO_FILENO, we don't notice problems with most pages, but raw patches write using printf(3). This is fine if we're outputting straight to stdout since the buffers are flushed on exit, but we close the cache output before this, so the cached output ends up being truncated. Make sure the buffers are flushed when we finish outputting a patch so that we avoid this. No other UIs use printf(3) so we do not need to worry about them. Actually, it's slightly more interesting than this... since we don't set GIT_FLUSH, Git decides whether or not it will flush stdout after writing each commit based on whether or not stdout points to a regular file (in maybe_flush_or_die()). Which means that when writing directly to the webserver, Git flushes stdout for us, but when we redirect stdout to the cache it points to a regular file so Git no longer flushes the output for us. The patch is still correct, but perhaps the full explanation is interesting! Reported-by: Konstantin Ryabitsev <mricon@kernel.org> 2014-06-28ui-log: ignore unhandled argumentsJohn Keeping If you search for a bogus range string here: http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/log/ Using something like "range" and "qwerty123456", it returns an "Internal Server Error" and the following in the logs: > [Tue Jun 10 17:45:32 2014] [error] [client 172.21.1.6] fatal: > ambiguous argument 'qwerty123456': unknown revision or path not in the > working tree., referer: > http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/ > [Tue Jun 10 17:45:32 2014] [error] [client 172.21.1.6] Use '--' to > separate paths from revisions, like this:, referer: > http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/ > [Tue Jun 10 17:45:32 2014] [error] [client 172.21.1.6] 'git <command> > [<revision>...] -- [<file>...]', referer: > http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/ > [Tue Jun 10 17:45:32 2014] [error] [client 172.21.1.6] Premature end > of script headers: cgit, referer: > http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/ The cache will kick in, so if you search for the same string again, it'll show an empty range, so you have to change the bogus strings each time. This is because we just pass the arguments straight to Git's revision parsing machinery which die()s if it cannot parse an argument, printing the above to stderr and exiting. The patch below makes it a bit friendlier by just ignoring unhandled arguments, but I can't see an easy way to report errors when we can't parse revision arguments without losing the flexibility of supporting all of the revision specifiers supported by Git. Reported-by: Konstantin Ryabitsev <mricon@kernel.org> 2014-06-28git: update for git 2.0Christian Hesse prefixcmp() and suffixcmp() have been remove, functionality is now provided by starts_with() and ends_with(). Retrurn values have been changed, so instead of just renaming we have to fix logic. Everything else looks just fine. 2014-04-17remove trailing whitespaces from source filesChristian Hesse 2014-04-12git: update to 1.9.2Christian Hesse Everything works just bumping the version in Makefile and commit hash in submodule. No code changes required. 2014-04-05Fix cgit_parse_url when a repo url is contained in another repo urlJulian Maurice For example, if I have two repos (remove-suffix is enabled): /foo /foo/bar http://cgit/foo/bar/ is interpreted as "repository 'foo', command 'bar'" instead of "repository 'foo/bar'" 2014-03-20Makefile: use more reliable git tarball mirrorJason A. Donenfeld 2014-03-20git: update to 1.9.1Christian Hesse