Skip to content
This repository was archived by the owner on Dec 7, 2018. It is now read-only.

Commit 08f38b9

Browse files
committed
INSTALL: Update configure option documentation
1 parent 7c2a7bc commit 08f38b9

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

INSTALL.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -98,16 +98,21 @@
9898
The behavior of gitblog.py can be configured by passing key/value pairs
9999
from Apache2 using PythonOption directives:
100100

101-
| Option name | Default | Description | Possible values |
102-
|-----------------------------|------------------------|---------------------------------------------|-----------------------------------------------|
103-
| gitblog.report_errors | False | Should errors be returned to users? | Boolean |
104-
| gitblog.www_repo | /dev/null | Path to the content git base repository | Filesystem path |
105-
| gitblog.default_ref | HEAD | Default git reference to display | Any git reference |
106-
| gitblog.default_output_type | html | Output format for called site | html, plain, markdown |
107-
| gitblog.footer | True | Display footer meta information | Boolean |
108-
| gitblog.date_format | %Y-%m-%d %H:%M | Date format in footer | String, see datetime |
109-
| gitblog.markdown2_extras | toc | Extra options when parsing content source | String, comma separated values, see markdown2 |
110-
| gitblog.max_age_blob | 1800 | Cache-Control max-age for non-text elements | Integer |
111-
| gitblog.max_age_tree | 600 | Cache-Control max-age for directory lising | Integer |
112-
| gitblog.denied_path | private,templates | Paths not to deliver (without leeding /) | String, comma separated values |
113-
| gitblog.redirect_code | HTTP_MOVED_PERMANENTLY | HTTP response code for redirects on links | HTTP_MOVED_PERMANENTLY, HTTP_MOVED_TEMPORARILY, HTTP_TEMPORARY_REDIRECT |
101+
| Option name | Default | Description | Possible values |
102+
|-----------------------------|------------------------------|---------------------------------------------|-----------------------------------------------|
103+
| gitblog.report_errors | False | Should errors be returned to users? | Boolean |
104+
| gitblog.www_repo | /dev/null | Path to the content git base repository | Filesystem path |
105+
| gitblog.default_ref | HEAD | Default git reference to display | Any git reference |
106+
| gitblog.default_output_type | html | Output format for called site | html, plain, markdown |
107+
| gitblog.footer | True | Display footer meta information | Boolean |
108+
| gitblog.date_format | %Y-%m-%d %H:%M | Date format in footer | String, see datetime |
109+
| gitblog.markdown2_extras | toc | Extra options when parsing content source | String, comma separated values, see markdown2 |
110+
| gitblog.max_age_blob | 1800 | Cache-Control max-age for non-text elements | Integer |
111+
| gitblog.max_age_tree | 600 | Cache-Control max-age for directory lising | Integer |
112+
| gitblog.denied_path | private,templates | Paths not to deliver | String, comma separated values |
113+
| gitblog.hidden_path | private,templates,robots.txt | Paths not shown in directory listings | String, comma separated values |
114+
| gitblog.direct_path | robots.txt | Paths to deliver without parsing | String, comma separated values |
115+
| gitblog.redirect_code | HTTP_MOVED_PERMANENTLY | HTTP response code for redirects on links | HTTP_MOVED_PERMANENTLY, HTTP_MOVED_TEMPORARILY, HTTP_TEMPORARY_REDIRECT |
116+
117+
Option notes:
118+
* denied_path, hidden_path, direct_path: Paths without leading /

0 commit comments

Comments
 (0)