diff options
Diffstat (limited to 'cgitrc.5.txt')
-rw-r--r-- | cgitrc.5.txt | 30 |
1 files changed, 26 insertions, 4 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 5903a93..8e31578 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -42,7 +42,7 @@ agefile:: | |||
42 | 42 | ||
43 | cache-root:: | 43 | cache-root:: |
44 | Path used to store the cgit cache entries. Default value: | 44 | Path used to store the cgit cache entries. Default value: |
45 | "/var/cache/cgit". | 45 | "/var/cache/cgit". See also: "MACRO EXPANSION". |
46 | 46 | ||
47 | cache-dynamic-ttl:: | 47 | cache-dynamic-ttl:: |
48 | Number which specifies the time-to-live, in minutes, for the cached | 48 | Number which specifies the time-to-live, in minutes, for the cached |
@@ -161,7 +161,7 @@ header:: | |||
161 | 161 | ||
162 | include:: | 162 | include:: |
163 | Name of a configfile to include before the rest of the current config- | 163 | Name of a configfile to include before the rest of the current config- |
164 | file is parsed. Default value: none. | 164 | file is parsed. Default value: none. See also: "MACRO EXPANSION". |
165 | 165 | ||
166 | index-header:: | 166 | index-header:: |
167 | The content of the file specified with this option will be included | 167 | The content of the file specified with this option will be included |
@@ -243,7 +243,8 @@ noheader:: | |||
243 | project-list:: | 243 | project-list:: |
244 | A list of subdirectories inside of scan-path, relative to it, that | 244 | A list of subdirectories inside of scan-path, relative to it, that |
245 | should loaded as git repositories. This must be defined prior to | 245 | should loaded as git repositories. This must be defined prior to |
246 | scan-path. Default value: none. See also: scan-path. | 246 | scan-path. Default value: none. See also: scan-path, "MACRO |
247 | EXPANSION". | ||
247 | 248 | ||
248 | readme:: | 249 | readme:: |
249 | Text which will be used as default value for "repo.readme". Default | 250 | Text which will be used as default value for "repo.readme". Default |
@@ -295,7 +296,8 @@ scan-path:: | |||
295 | scan-path loads only the directories listed in the file pointed to by | 296 | scan-path loads only the directories listed in the file pointed to by |
296 | project-list. Be advised that only the global settings taken | 297 | project-list. Be advised that only the global settings taken |
297 | before the scan-path directive will be applied to each repository. | 298 | before the scan-path directive will be applied to each repository. |
298 | Default value: none. See also: cache-scanrc-ttl, project-list. | 299 | Default value: none. See also: cache-scanrc-ttl, project-list, |
300 | "MACRO EXPANSION". | ||
299 | 301 | ||
300 | section:: | 302 | section:: |
301 | The name of the current repository section - all repositories defined | 303 | The name of the current repository section - all repositories defined |
@@ -492,6 +494,26 @@ allocated buffer within cgit then only the environment variables that fit | |||
492 | in the allocated buffer are handed to the filter. | 494 | in the allocated buffer are handed to the filter. |
493 | 495 | ||
494 | 496 | ||
497 | MACRO EXPANSION | ||
498 | --------------- | ||
499 | The following cgitrc options supports a simple macro expansion feature, | ||
500 | where tokens prefixed with "$" are replaced with the value of a similary | ||
501 | named environment variable: | ||
502 | |||
503 | - cache-root | ||
504 | - include | ||
505 | - project-list | ||
506 | - scan-path | ||
507 | |||
508 | Macro expansion will also happen on the content of $CGIT_CONFIG, if | ||
509 | defined. | ||
510 | |||
511 | One usage of this feature is virtual hosting, which in its simplest form | ||
512 | can be accomplished by adding the following line to /etc/cgitrc: | ||
513 | |||
514 | include=/etc/cgitrc.d/$HTTP_HOST | ||
515 | |||
516 | |||
495 | EXAMPLE CGITRC FILE | 517 | EXAMPLE CGITRC FILE |
496 | ------------------- | 518 | ------------------- |
497 | 519 | ||