about summary refs log tree commit diff
path: root/cgitrc
diff options
context:
space:
mode:
Diffstat (limited to 'cgitrc')
-rw-r--r--cgitrc53
1 files changed, 32 insertions, 21 deletions
diff --git a/cgitrc b/cgitrc
index da3d138..d45f9c2 100644
--- a/cgitrc
+++ b/cgitrc
@@ -3,50 +3,60 @@
 ##
 
 
-## base for virtual urls. If specified, rewrite rules must be added to 
-## httpd.conf. Possible rules for /git/ when cgit.cgi is accessed as /cgit.cgi:
+## Uncomment and set to 1 to deactivate caching of generated pages. Mostly
+## usefull for testing.
+#nocache=0
+
+
+## Specify a root for virtual urls. This makes cgit generate urls like
+##
+##    http://localhost/git/repo/log/?id=master
+##
+## instead of
 ##
-##   RewriteRule ^/git/$ /cgit.cgi                            [L,QSA]
-##   RewriteRule ^/git/([^/]+)/$ /cgit.cgi?r=$1               [L,QSA]
-##   RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit.cgi?r=$1&p=$2  [L,QSA]
+##    http://localhost/cgit/cgit.cgi?r=repo&p=log&id=master
 ##
+## For this to work with apache, rewrite rules must be added to httpd.conf,
+## possibly looking something like this:
+##
+##   RewriteRule ^/git/$ /cgit/cgit.cgi                            [L,QSA]
+##   RewriteRule ^/git/([^/]+)/$ /cgit/cgit.cgi?r=$1               [L,QSA]
+##   RewriteRule ^/git/([^/]+)/([^/]+)/$ /cgit/cgit.cgi?r=$1&p=$2  [L,QSA]
+##
+## This setting is disabled by default.
 #virtual-root=/git
 
 
-## page title for the root page (repo listing)
+## Set the title printed on the root page
 #root-title=Git repository browser
 
 
-## link to css file
-#css=/cgit.css
+## Link to css file
+#css=/cgit/cgit.css
 
 
-## link to logo file
-#logo=/git-logo.png
+## Link to logo file
+#logo=/cgit/git-logo.png
 
 
-## url loaded when clicking the logo
+## Url loaded when clicking the logo
 #logo-link=http://www.kernel.org/pub/software/scm/git/docs/
 
 
-## set number of initial chars to show of commit subject message in log views
+## Number of chars shown of commit subject message (in log view)
 #max-message-length=60
 
 
-## Set to 1 to deactivate caching of generated pages
-#nocache=0
-
-
-## root path for cached output
+## Root of cached output
 #cache-root=/var/cache/cgit
 
 
 ##
-## Time-To-Live settings: specify how long (in minutes) different pages should
-## be cached. Specify 0 for instant expiration and -1 for immortal pages
+## Time-To-Live settings: specifies how long (in minutes) different pages 
+## should be cached (0 for instant expiration, -1 for immortal pages)
 ##
 
-## ttl for root page (repo listing)
+## ttl for root page
 #cache-root-ttl=5
 
 ## ttl for repo summary page
@@ -60,7 +70,8 @@
 
 
 
-## Example repository entry
+## Example repository entry. Required values are repo.url and repo.path (each
+## repository section must start with repo.url).
 #repo.url=cgit
 #repo.name=cgit
 #repo.desc=the caching cgi for git
2014-01-19cache: use sendfile() instead of a pair of read() + write()Sebastian Andrzej Siewior sendfile() does the same job and avoids to copy the content into userland and back. One has to define NO_SENDFILE in case the OS (kernel / libc) does not supported. It is disabled by default on non-linux environemnts. According to the glibc, sendfile64() was added in Linux 2.4 (so it has been there for a while) but after browsing over the mapage of FreeBSD's I noticed that the prototype is little different. Signed-off-by: Sebastian Andrzej Siewior <sebastian@breakpoint.cc> 2014-01-19README: document pkg-config for luajitJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17makefile: bump versionJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17mailmap: source before lighttpdJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17ui-shared: do not allow negative minutesJason A. Donenfeld Do to timestamp differences, sometimes cgit would should "-0 min", which doesn't make any sense. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17auth: document tweakables in lua scriptJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17repolist: make owner clickable to searchJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17ui-shared: move about tab all the way to the leftJason A. Donenfeld There were no objections (at the time of committing this): http://lists.zx2c4.com/pipermail/cgit/2013-May/001393.html http://lists.zx2c4.com/pipermail/cgit/2014-January/001904.html Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17filter: don't forget to reap the auth filterJason A. Donenfeld Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> 2014-01-17cgit.c: free tmp variableJason A. Donenfeld 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