From e2416259efe8b9bdad9be9597b1a79443dafdb4e Mon Sep 17 00:00:00 2001 From: Lukas Fleischer Date: Wed, 8 Jan 2014 19:45:29 +0100 Subject: README: Spelling and formatting fixes * Several small spelling and capitalization fixes. * Use consistent and better-looking formatting that is compatible with AsciiDoc (and partly compatible with RST). Signed-off-by: Lukas Fleischer --- README | 82 +++++++++++++++++++++++++++++++++--------------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) (limited to 'README') diff --git a/README b/README index 8e4ed53..0c35f96 100644 --- a/README +++ b/README @@ -1,86 +1,86 @@ +cgit - CGI for Git +================== - cgit - cgi for git - - -This is an attempt to create a fast web interface for the git scm, using a -builtin cache to decrease server io-pressure. - +This is an attempt to create a fast web interface for the Git SCM, using a +built-in cache to decrease server I/O pressure. Installation +------------ -Building cgit involves building a proper version of git. How to do this +Building cgit involves building a proper version of Git. How to do this depends on how you obtained the cgit sources: a) If you're working in a cloned cgit repository, you first need to -initialize and update the git submodule: +initialize and update the Git submodule: - $ git submodule init # register the git submodule in .git/config - $ $EDITOR .git/config # if you want to specify a different url for git - $ git submodule update # clone/fetch and checkout correct git version + $ git submodule init # register the Git submodule in .git/config + $ $EDITOR .git/config # if you want to specify a different url for git + $ git submodule update # clone/fetch and checkout correct git version b) If you're building from a cgit tarball, you can download a proper git version like this: - $ make get-git - + $ make get-git When either a) or b) has been performed, you can build and install cgit like this: - $ make - $ sudo make install + $ make + $ sudo make install -This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit". You can -configure this location (and a few other things) by providing a "cgit.conf" +This will install `cgit.cgi` and `cgit.css` into `/var/www/htdocs/cgit`. You +can configure this location (and a few other things) by providing a `cgit.conf` file (see the Makefile for details). +Dependencies +------------ -Dependencies: - -git 1.7.4 - -zip lib - -crypto lib - -openssl lib - +* git 1.7.4 +* zip lib +* crypto lib +* openssl lib Apache configuration +-------------------- -A new Directory-section must probably be added for cgit, possibly something +A new `Directory` section must probably be added for cgit, possibly something like this: - - AllowOverride None - Options +ExecCGI - Order allow,deny - Allow from all - + + AllowOverride None + Options +ExecCGI + Order allow,deny + Allow from all + Runtime configuration +--------------------- -The file /etc/cgitrc is read by cgit before handling a request. In addition +The file `/etc/cgitrc` is read by cgit before handling a request. In addition to runtime parameters, this file may also contain a list of repositories -displayed by cgit (see cgitrc.5.txt for further details). - +displayed by cgit (see `cgitrc.5.txt` for further details). 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 +When cgit is invoked it looks for a cache file matching the request and +returns it to the client. If no such cache file exists (or if it has expired), +the content for the request is written into the proper cache file 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 +If the cache file has expired but cgit is unable to obtain a lock for it, the +stale cache file is returned to the client. This is done to favour page throughput over page freshness. The generated content contains the complete response to the client, including -the http-headers "Modified" and "Expires". - +the HTTP headers `Modified` and `Expires`. Online presence +--------------- * The cgit homepage is hosted by cgit at -* Patches, bugreports, discussions and support should go to the cgit +* Patches, bug reports, discussions and support should go to the cgit mailing list: . To sign up, visit -- cgit 1.4.1 Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17Switch to exclusively using global ctxLukas Fleischer Drop the context parameter from the following functions (and all static helpers used by them) and use the global context instead: * cgit_print_http_headers() * cgit_print_docstart() * cgit_print_pageheader() Remove context parameter from all commands Drop the context parameter from the following functions (and all static helpers used by them) and use the global context instead: * cgit_get_cmd() * All cgit command functions. * cgit_clone_info() * cgit_clone_objects() * cgit_clone_head() * cgit_print_plain() * cgit_show_stats() In initialization routines, use the global context variable instead of passing a pointer around locally. Remove callback data parameter for cache slots This is no longer needed since the context is always read from the global context variable. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-16auth: have cgit calculate login addressJason A. Donenfeld This way we're sure to use virtual root, or any other strangeness encountered. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-16auth: lua string comparisons are time invariantJason A. Donenfeld By default, strings are compared by hash, so we can remove this comment. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-16authentication: use hidden form instead of refererJason A. Donenfeld This also gives us some CSRF protection. Note that we make use of the hmac to protect the redirect value. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-16auth: add basic authentication filter frameworkJason A. Donenfeld This leverages the new lua support. See filters/simple-authentication.lua for explaination of how this works. There is also additional documentation in cgitrc.5.txt. Though this is a cookie-based approach, cgit's caching mechanism is preserved for authenticated pages. Very plugable and extendable depending on user needs. The sample script uses an HMAC-SHA1 based cookie to store the currently logged in user, with an expiration date. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-16t0111: Additions and fixesLukas Fleischer * Rename the capitalize-* filters to dump.* since they also dump the arguments. * Add full argument validation to the email filters. Signed-off-by: Lukas Fleischer <cgit@cryptocrack.de> 2014-01-16parsing.c: Remove leading space from committerLukas Fleischer