Refactor snapshot support

[cgit.git] / cgitrc

diff --git a/cgitrc b/cgitrc
index 019781eaab2c036eee13440365ac85ed807801c2..ce0c01bd689f473dc8c8f7e6da2342cec1c0b813 100644 (file)
--- a/cgitrc
+++ b/cgitrc
@@ -8,24 +8,79 @@
 #nocache=0
 
 
 #nocache=0
 
 

-## Enable/disable snapshots by default. This can be overridden per repo
+## This variable can be used to override the default value for "robots"
+## meta-tag. If unset, the meta-tag isn't generated.
+#robots=index, nofollow
+
+
+## Set allowed snapshot types by default. Can be overridden per repo
+# can be any combination of zip/tar.gz/tar.bz2/tar

 #snapshots=0
 
 
 #snapshots=0
 
 

+## Enable/disable extra links to summary/log/tree per repo on index page
+#enable-index-links=0
+
+
+## Enable/disable display of 'number of files changed' in log view
+#enable-log-filecount=0
+
+
+## Enable/disable display of 'number of lines changed' in log view
+#enable-log-linecount=0
+
+
+## Enable/disable display of HEAD shortlog in summary view. Set it to maximum
+## number of commits that should be displayed
+#summary-log=0
+
+
+## Restrict the number of branches printed in summary view. Set to 0 to
+## print all branches.
+#summary-branches=0
+
+
+## Restrict the number of tags printed in summary view. Set to 0 to
+## print all tags.
+#summary-tags=0
+
+
+## The "Idle" column on the repository index page can read a timestamp
+## from the specified agefile (if this file cannot be found, the mtime
+## of HEAD is used).
+## The cgit repo on hjemli.net uses the the following command in it's
+## post-receive hook to update the age-file:
+##   git-for-each-ref --format="%(committerdate)" --sort=-committerdate \
+##     --count=1 > $GIT_DIR/info/web/last-modifie
+##
+#agefile=info/web/last-modified
+
+
+## Git detects renames, but with a limit on the number of files to
+## consider. This option can be used to specify another limit (or -1 to
+## use the default limit).
+##
+#renamelimit=-1
+
+

 ## Specify a root for virtual urls. This makes cgit generate urls like
 ##
 ## Specify a root for virtual urls. This makes cgit generate urls like
 ##

-##    http://localhost/git/repo/log/?id=master
+##    http://localhost/git/repo/log/?h=branch

 ##
 ## instead of
 ##
 ##
 ## instead of
 ##

-##    http://localhost/cgit/cgit.cgi?r=repo&p=log&id=master
+##    http://localhost/cgit/cgit.cgi?url=repo/log&h=branch

 ##
 ##

-## For this to work with apache, rewrite rules must be added to httpd.conf,
+## For this to work with apache, a rewrite rule must be added to httpd.conf,

 ## possibly looking something like this:
 ##
 ## 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]
+##    RewriteRule ^/git/(.*)$ /cgit/cgit.cgi?url=$1   [L,QSA]
+##
+## For this to work with lighttpd, the rewrite rule should look more like this:
+##
+##    url.rewrite = (
+##        "^/git/([^?/]+/[^?]*)?(?:\?(.*))?$" => "/cgit.cgi?url=$1&$2"
+##    )

 ##
 ## This setting is disabled by default.
 #virtual-root=/git
 ##
 ## This setting is disabled by default.
 #virtual-root=/git


@@ -35,6 +90,16 @@
 #root-title=Git repository browser
 
 
 #root-title=Git repository browser
 
 

+## If specified, the file at this path will be included as HTML in the
+## sidebar on the repository index page
+#index-info=
+
+
+## If specified, the file at this path will be included as HTML above
+## the repository index
+#index-header=
+
+

 ## Link to css file
 #css=/cgit/cgit.css
 
 ## Link to css file
 #css=/cgit/cgit.css
 


@@ -51,6 +116,15 @@
 #module-link=./?repo=%s&page=commit&id=%s
 
 
 #module-link=./?repo=%s&page=commit&id=%s
 
 

+## Shared prefix which, when combined with repo url, becomes the url used
+## to clone the repo
+#clone-prefix=
+
+
+## Number of chars shown of repo description (in repolist view)
+#max-repodesc-length=60
+
+

 ## Number of chars shown of commit subject message (in log view)
 #max-message-length=60
 
 ## Number of chars shown of commit subject message (in log view)
 #max-message-length=60
 


@@ -63,8 +137,11 @@
 #cache-root=/var/cache/cgit
 
 
 #cache-root=/var/cache/cgit
 
 

+## Include another config-file
+#include=/var/cgit/repolist
+

 ##
 ##

-## Time-To-Live settings: specifies how long (in minutes) different pages 
+## Time-To-Live settings: specifies how long (in minutes) different pages

 ## should be cached (0 for instant expiration, -1 for immortal pages)
 ##
 
 ## should be cached (0 for instant expiration, -1 for immortal pages)
 ##
 


@@ -74,7 +151,7 @@
 ## ttl for repo summary page
 #cache-repo-ttl=5
 
 ## ttl for repo summary page
 #cache-repo-ttl=5
 

-## ttl for other dynamic pages 
+## ttl for other dynamic pages

 #cache-dynamic-ttl=5
 
 ## ttl for static pages (addressed by SHA-1)
 #cache-dynamic-ttl=5
 
 ## ttl for static pages (addressed by SHA-1)


@@ -87,7 +164,31 @@
 #repo.url=cgit
 #repo.name=cgit
 #repo.desc=the caching cgi for git
 #repo.url=cgit
 #repo.name=cgit
 #repo.desc=the caching cgi for git

-#repo.path=/pub/git/cgit
+#repo.path=/pub/git/cgit                       ## this is the path to $GIT_DIR

 #repo.owner=Lars Hjemli
 #repo.owner=Lars Hjemli

-#repo.snapshots=1                              # override a sitewide snapshot-setting
-#repo.module-link=/git/%s/commit/?id=%s                # override the standard module-link
+#repo.defbranch=master                         ## define a default branch
+#repo.snapshots=tar.bz2                                ## override a sitewide snapshot-setting
+#repo.enable-log-filecount=0                   ## override the default filecount setting
+#repo.enable-log-linecount=0                   ## override the default linecount setting
+#repo.module-link=/git/%s/commit/?id=%s                ## override the standard module-link
+#repo.readme=info/web/readme                   ## specify a file to include on summary page
+#repo.clone-url=git://hjemli.net/pub/git/cgit
+
+## Additional repositories grouped under "mirrors"
+#repo.group=mirrors
+
+#repo.url=git
+#repo.path=/pub/git/git
+#repo.clone-url=git://hjemli.net/pub/git/git
+#
+#repo.url=linux
+#repo.path=/pub/git/linux
+
+## A group of private repositories (with a working directory)
+#repo.group=private
+
+#repo.url=larsh/cgit
+#repo.path=/home/larsh/src/cgit/.git
+
+#repo.url=larsh/git
+#repo.path=/home/larsh/src/git/.git