diff options
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r-- | cgitrc.5.txt | 42 |
1 files changed, 28 insertions, 14 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8eafc4a..cbaebca 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -60,37 +60,41 @@ cache-root:: | |||
60 | 60 | ||
61 | cache-static-ttl:: | 61 | cache-static-ttl:: |
62 | Number which specifies the time-to-live, in minutes, for the cached | 62 | Number which specifies the time-to-live, in minutes, for the cached |
63 | version of repository pages accessed with a fixed SHA1. Negative | 63 | version of repository pages accessed with a fixed SHA1. See also: |
64 | values have infinite ttl. Default value: -1". | 64 | "CACHE". Default value: -1". |
65 | 65 | ||
66 | cache-dynamic-ttl:: | 66 | cache-dynamic-ttl:: |
67 | Number which specifies the time-to-live, in minutes, for the cached | 67 | Number which specifies the time-to-live, in minutes, for the cached |
68 | version of repository pages accessed without a fixed SHA1. Negative | 68 | version of repository pages accessed without a fixed SHA1. See also: |
69 | values have infinite ttl. Default value: "5". | 69 | "CACHE". Default value: "5". |
70 | 70 | ||
71 | cache-repo-ttl:: | 71 | cache-repo-ttl:: |
72 | Number which specifies the time-to-live, in minutes, for the cached | 72 | Number which specifies the time-to-live, in minutes, for the cached |
73 | version of the repository summary page. Negative values have infinite | 73 | version of the repository summary page. See also: "CACHE". Default |
74 | ttl. Default value: "5". | 74 | value: "5". |
75 | 75 | ||
76 | cache-root-ttl:: | 76 | cache-root-ttl:: |
77 | Number which specifies the time-to-live, in minutes, for the cached | 77 | Number which specifies the time-to-live, in minutes, for the cached |
78 | version of the repository index page. Negative values have infinite | 78 | version of the repository index page. See also: "CACHE". Default |
79 | ttl. Default value: "5". | 79 | value: "5". |
80 | 80 | ||
81 | cache-scanrc-ttl:: | 81 | cache-scanrc-ttl:: |
82 | Number which specifies the time-to-live, in minutes, for the result | 82 | Number which specifies the time-to-live, in minutes, for the result |
83 | of scanning a path for git repositories. Negative values have infinite | 83 | of scanning a path for git repositories. See also: "CACHE". Default |
84 | ttl. Default value: "15". | 84 | value: "15". |
85 | 85 | ||
86 | cache-about-ttl:: | 86 | cache-about-ttl:: |
87 | Number which specifies the time-to-live, in minutes, for the cached | 87 | Number which specifies the time-to-live, in minutes, for the cached |
88 | version of the repository about page. Negative values have infinite | 88 | version of the repository about page. See also: "CACHE". Default |
89 | ttl. Default value: "15". | 89 | value: "15". |
90 | |||
91 | cache-snapshot-ttl:: | ||
92 | Number which specifies the time-to-live, in minutes, for the cached | ||
93 | version of snapshots. See also: "CACHE". Default value: "5". | ||
90 | 94 | ||
91 | cache-size:: | 95 | cache-size:: |
92 | The maximum number of entries in the cgit cache. Default value: "0" | 96 | The maximum number of entries in the cgit cache. When set to "0", |
93 | (i.e. caching is disabled). | 97 | caching is disabled. See also: "CACHE". Default value: "0" |
94 | 98 | ||
95 | case-sensitive-sort:: | 99 | case-sensitive-sort:: |
96 | Sort items in the repo list case sensitively. Default value: "1". | 100 | Sort items in the repo list case sensitively. Default value: "1". |
@@ -712,6 +716,16 @@ the environment variables defined in "FILTER API": | |||
712 | - repo.clone-url | 716 | - repo.clone-url |
713 | 717 | ||
714 | 718 | ||
719 | CACHE | ||
720 | ------ | ||
721 | |||
722 | All cache ttl values are in minutes. Negative ttl values indicate that a page | ||
723 | type will never expire, and thus the first time a URL is accessed, the result | ||
724 | will be cached indefinitely, even if the underlying git repository changes. | ||
725 | Conversely, when a ttl value is zero, the cache is disabled for that | ||
726 | particular page type, and the page type is never cached. | ||
727 | |||
728 | |||
715 | EXAMPLE CGITRC FILE | 729 | EXAMPLE CGITRC FILE |
716 | ------------------- | 730 | ------------------- |
717 | 731 | ||