about summary refs log tree commit diff stats
path: root/cgitrc.5.txt
diff options
context:
space:
mode:
authorJason A. Donenfeld2013-05-28 16:33:30 +0200
committerJason A. Donenfeld2013-08-12 13:14:10 -0600
commit61ff10065b579fa38182fcf10cc7e63839acd53c (patch)
tree0d4b37af5a034c10763f7d0f1c39af55fabed115 /cgitrc.5.txt
parentrobots.txt: disallow access to snapshots (diff)
downloadcgit-61ff10065b579fa38182fcf10cc7e63839acd53c.tar.gz
cgit-61ff10065b579fa38182fcf10cc7e63839acd53c.zip
cache: document negative ttls and add about ttl
We've long supported negative ttls, for infinite cache, except the
documentation incorrectly showed one of our defaults as being 5 and not
-1. As well, with a negative ttl, we were actually making the HTTP
expired header go backwards. This changes it to go ahead ten years
instead.

Further, we add an cache-about-ttl option to set a different ttl for
about pages, which are now increasingly being filtered through markdown
or just sent statically anyway.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r--cgitrc.5.txt28
1 files changed, 18 insertions, 10 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index b4603ef..9d0c089 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt
@@ -50,32 +50,40 @@ cache-root::
50 Path used to store the cgit cache entries. Default value: 50 Path used to store the cgit cache entries. Default value:
51 "/var/cache/cgit". See also: "MACRO EXPANSION". 51 "/var/cache/cgit". See also: "MACRO EXPANSION".
52 52
53cache-static-ttl::
54 Number which specifies the time-to-live, in minutes, for the cached
55 version of repository pages accessed with a fixed SHA1. Negative
56 values have infinite ttl. Default value: -1".
57
53cache-dynamic-ttl:: 58cache-dynamic-ttl::
54 Number which specifies the time-to-live, in minutes, for the cached 59 Number which specifies the time-to-live, in minutes, for the cached
55 version of repository pages accessed without a fixed SHA1. Default 60 version of repository pages accessed without a fixed SHA1. Negative
56 value: "5". 61 values have infinite ttl. Default value: "5".
57 62
58cache-repo-ttl:: 63cache-repo-ttl::
59 Number which specifies the time-to-live, in minutes, for the cached 64 Number which specifies the time-to-live, in minutes, for the cached
60 version of the repository summary page. Default value: "5". 65 version of the repository summary page. Negative values have infinite
66 ttl. Default value: "5".
61 67
62cache-root-ttl:: 68cache-root-ttl::
63 Number which specifies the time-to-live, in minutes, for the cached 69 Number which specifies the time-to-live, in minutes, for the cached
64 version of the repository index page. Default value: "5". 70 version of the repository index page. Negative values have infinite
71 ttl. Default value: "5".
65 72
66cache-scanrc-ttl:: 73cache-scanrc-ttl::
67 Number which specifies the time-to-live, in minutes, for the result 74 Number which specifies the time-to-live, in minutes, for the result
68 of scanning a path for git repositories. Default value: "15". 75 of scanning a path for git repositories. Negative values have infinite
76 ttl. Default value: "15".
77
78cache-about-ttl::
79 Number which specifies the time-to-live, in minutes, for the cached
80 version of the repository about page. Negative values have infinite
81 ttl. Default value: "15".
69 82
70cache-size:: 83cache-size::
71 The maximum number of entries in the cgit cache. Default value: "0" 84 The maximum number of entries in the cgit cache. Default value: "0"
72 (i.e. caching is disabled). 85 (i.e. caching is disabled).
73 86
74cache-static-ttl::
75 Number which specifies the time-to-live, in minutes, for the cached
76 version of repository pages accessed with a fixed SHA1. Default value:
77 "5".
78
79case-sensitive-sort:: 87case-sensitive-sort::
80 Sort items in the repo list case sensitively. Default value: "1". 88 Sort items in the repo list case sensitively. Default value: "1".
81 See also: repository-sort, section-sort. 89 See also: repository-sort, section-sort.