# jgm/gitit

### Subversion checkout URL

You can clone with
or
.
Newer
Older
100644 260 lines (216 sloc) 10.3 KB
 e5f8cc1 Removed some comments from default.conf header. John MacFarlane authored May 3, 2009 1 # gitit wiki configuration file ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 12, 2009 2 3 port: 5001 4 # sets the port on which the web server will run. 5 19cbba6 Use wikiTitle config field in default HTML title. John MacFarlane authored Nov 15, 2009 6 wiki-title: Wiki 7 # the title of the wiki. 8 ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 9 repository-type: Git 10 # specifies the type of repository used for wiki content. 13b66f4 Added support for the new mercurial filestore backend. jgm authored Dec 12, 2009 11 # Options are Git, Darcs, and Mercurial. ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 12 13 repository-path: wikidata 14 # specifies the path of the repository directory. If it does not 15 # exist, gitit will create it on startup. 16 726e0b3 Added authentication-required field. jgm authored Mar 29, 2011 17 require-authentication: modify 18 # if 'none', login is never required, and pages can be edited anonymously. 19 # if 'modify', login is required to modify the wiki (edit, add, delete 20 # pages, upload files). 21 # if 'read', login is required to see any wiki pages. 22 99bba58 Added http-authentication to configuration. jgm authored May 10, 2009 23 authentication-method: form 24 # 'form' means that users will be logged in and registered 77feb88 Changed AuthHTTPDigest -> AuthHTTP, 'digest' -> 'http'. jgm authored May 11, 2009 25 # using forms in the gitit web interface. 'http' means 26 # that gitit will assume that HTTP authentication is in 99bba58 Added http-authentication to configuration. jgm authored May 11, 2009 27 # place and take the logged in username from the "Authorization" 068e780 Major architectural revision of authentication system. jgm authored Jul 31, 2009 28 # field of the HTTP request header (in addition, 29 # the login/logout and registration links will be 30 # suppressed). 'generic' means that gitit will assume that 31 # some form of authentication is in place that directly 32 # sets REMOTE_USER to the name of the authenticated user 3cf6676 Added RPX support again, using stripped-down module. jgm authored Apr 1, 2011 33 # (e.g. mod_auth_cas on apache). 'rpx' means that gitit 34 # will attempt to log in through https://rpxnow.com. 1bc9242 Use base-url to set rpx token_url. jgm authored Apr 5, 2011 35 # This requires that 'rpx-domain', 'rpx-key', and 'base-url' 36 # be set below, and that 'curl' be in the system path. 99bba58 Added http-authentication to configuration. jgm authored May 11, 2009 37 ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 38 user-file: gitit-users 39 # specifies the path of the file containing user login information. 40 # If it does not exist, gitit will create it (with an empty user list). 77feb88 Changed AuthHTTPDigest -> AuthHTTP, 'digest' -> 'http'. jgm authored May 11, 2009 41 # This file is not used if 'http' is selected for authentication-method. ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 42 7212791 Added session-timeout config setting. jgm authored Mar 7, 2010 43 session-timeout: 60 44 # number of minutes of inactivity before a session expires. 45 ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 46 static-dir: static 47 # specifies the path of the static directory (containing javascript, 48 # css, and images). If it does not exist, gitit will create it 49 # and populate it with required scripts, stylesheets, and images. 50 fe14fa8 Added functions for a password reset email. John MacFarlane authored Apr 23, 2009 51 default-page-type: Markdown be62fa3 Added Context and configuration fields for literate Haskell. John MacFarlane authored May 3, 2009 52 # specifies the type of markup used to interpret pages in the wiki. 53 # Possible values are Markdown, RST, LaTeX, HTML, Markdown+LHS, RST+LHS, 54 # and LaTeX+LHS. (The +LHS variants treat the input as 55 # literate Haskell. See pandoc's documentation for more details.) If 56 # Markdown is selected, pandoc's syntax extensions (for footnotes, 57 # delimited code blocks, etc.) will be enabled. Note that pandoc's 58 # reStructuredText parser is not complete, so some pages may not be 59 # rendered correctly if RST is selected. The same goes for LaTeX and 60 # HTML. ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 61 cf93c6e Revert "Use pandoc's new mathml capabilities for MathML math method." John MacFarlane authored Mar 21, 2010 62 math: MathML 18ff134 Added math config option, native mathml support. jgm authored Aug 22, 2009 63 # specifies how LaTeX math is to be displayed. Possible values 1892d65 Support mathjax as a math option. John MacFarlane authored Sep 3, 2011 64 # are MathML, raw, mathjax, jsMath, and google. If mathml is selected, 65 # gitit will convert LaTeX math to MathML and link in a script, 66 # MathMLinHTML.js, that allows the MathML to be seen in Gecko browsers, IE + 67 # mathplayer, and Opera. In other browsers you may get a jumble of characters. 68 # If raw is selected, the LaTeX math will be displayed as raw LaTeX math. 69 # If mathjax is selected, gitit will link to the remote mathjax script. 70 # If jsMath is selected, gitit will link to the script /js/jsMath/easy/load.js, 71 # and will assume that jsMath has been installed into the js/jsMath directory. 72 # This is the most portable solution. If google is selected, the google chart 73 # API is called to render the formula as an image. This requires a connection 30c7c82 Added google math option (uses google charts api). jgm authored Jul 15, 2010 74 # to google, and might raise a technical or a privacy problem. 18ff134 Added math config option, native mathml support. jgm authored Aug 22, 2009 75 8bfc98f Added show-lhs-bird-tracks config option. John MacFarlane authored May 3, 2009 76 show-lhs-bird-tracks: no 77 # specifies whether to show Haskell code blocks in "bird style", 78 # with "> " at the beginning of each line. 79 f1f023a Use nested templates in templates/ directory rather than template.html. jgm authored Jul 9, 2009 80 templates-dir: templates 81 # specifies the path of the directory containing page templates. 82 # If it does not exist, gitit will create it with default templates. 83 # Users may wish to edit the templates to customize the appearance of 84 # their wiki. The template files are HStringTemplate templates. 85 # Variables to be interpolated appear between $'s. Literal$'s must be 86 # backslash-escaped. ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 87 88 log-file: gitit.log 89 # specifies the path of gitit's log file. If it does not exist, 90 # gitit will create it. The log is in Apache combined log format. 91 92 log-level: WARNING 93 # determines how much information is logged. 94 # Possible values (from most to least verbose) are DEBUG, INFO, 95 # NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. 96 97 front-page: Front Page 98 # specifies which wiki page is to be used as the wiki's front page. 99 # Gitit creates a default front page on startup, if one does not exist 100 # already. 101 102 no-delete: Front Page, Help 103 # specifies pages that cannot be deleted through the web interface. 104 # (They can still be deleted directly using git or darcs.) 105 # A comma-separated list of page names. Leave blank to allow 106 # every page to be deleted. 107 108 no-edit: Help 109 # specifies pages that cannot be edited through the web interface. 110 # Leave blank to allow every page to be edited. 111 cea1629 Added default-summary config option. jgm authored Jun 25, 2009 112 default-summary: 113 # specifies text to be used in the change description if the author 114 # leaves the "description" field blank. If default-summary is blank 115 # (the default), the author will be required to fill in the description 116 # field. 117 ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 118 table-of-contents: yes 119 # specifies whether to print a tables of contents (with links to 120 # sections) on each wiki page. 121 fe14fa8 Added functions for a password reset email. John MacFarlane authored Apr 23, 2009 122 plugins: ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 123 # specifies a list of plugins to load. Plugins may be specified 124 # either by their path or by their module name. If the plugin name 125 # starts with Gitit.Plugin., gitit will assume that the plugin is 126 # an installed module and will not try to find a source file. 127 # Examples: 128 # plugins: plugins/DotPlugin.hs, CapitalizeEmphasisPlugin.hs 129 # plugins: plugins/DotPlugin 130 # plugins: Gitit.Plugin.InterwikiLinks 131 f22d5c4 Changed default config to use-cache: no. jgm authored Aug 14, 2009 132 use-cache: no 6d918a1 Moved check for useFeed config option to cacheHtml & cachedHtml. jgm authored Aug 22, 2009 133 # specifies whether to cache rendered pages. Note that if use-feed 134 # is selected, feeds will be cached regardless of the value of use-cache. 3bd0461 Changed caching model and simplified ContentTransformer. jgm authored Aug 9, 2009 135 136 cache-dir: cache 137 # directory where rendered pages will be cached ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 138 4cab1d9 Allow numbers to be specified as e.g. '100K' in config file. jgm authored Apr 13, 2009 139 max-upload-size: 100K ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 140 # specifies an upper limit on the size (in bytes) of files uploaded 141 # through the wiki's web interface. 1d9457c disable upload functionality if maxUploadSize is 0 Thomas Hartman authored Jan 22, 2010 142 # To disable uploads, set this to 0K. 143 # This will result in the uploads link disappearing f4462a2 default.conf: Slight wording change in comment. John MacFarlane authored Jan 21, 2010 144 # and the _upload url becoming inactive. ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 145 e7406a2 Added max-page-size config option. jgm authored Mar 21, 2010 146 max-page-size: 100K 147 # specifies an upper limit on the size (in bytes) of pages 148 ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 149 debug-mode: no 150 # if "yes", causes debug information to be logged while gitit is running. 151 d7d47bd Added compressResponses configuration option. John MacFarlane authored Apr 17, 2009 152 compress-responses: yes 153 # specifies whether HTTP responses should be compressed. 154 ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 155 mime-types-file: /etc/mime.types 156 # specifies the path of a file containing mime type mappings. 157 # Each line of the file should contain two fields, separated by 158 # whitespace. The first field is the mime type, the second is a 159 # file extension. For example: 160 # video/x-ms-wmx wmx 161 # If the file is not found, some simple defaults will be used. 162 163 use-recaptcha: no 164 # if "yes", causes gitit to use the reCAPTCHA service 165 # (http://recaptcha.net) to prevent bots from creating accounts. 166 fe14fa8 Added functions for a password reset email. John MacFarlane authored Apr 23, 2009 167 recaptcha-private-key: 168 recaptcha-public-key: ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 169 # specifies the public and private keys for the reCAPTCHA service. 170 # To get these, you need to create an account at http://recaptcha.net. 171 172 access-question: fe14fa8 Added functions for a password reset email. John MacFarlane authored Apr 23, 2009 173 access-question-answers: ce07825 Added data/default.conf, which defines default config file values. jgm authored Apr 13, 2009 174 # specifies a question that users must answer when they attempt to create 175 # an account, along with a comma-separated list of acceptable answers. 176 # This can be used to institute a rudimentary password for signing up as 177 # a user on the wiki, or as an alternative to reCAPTCHA. 178 # Example: 179 # access-question: What is the code given to you by Ms. X? 180 # access-question-answers: RED DOG, red dog 181 02a14d2 Added 'rpx' as authentication-method, 'rpx-domain' & 'rpx-key' config. jgm authored Mar 28, 2011 182 rpx-domain: 183 rpx-key: 2e550e0 Fix up the docs describing rpx-domain bos authored Mar 29, 2011 184 # Specifies the domain and key of your RPX account. The domain is 185 # just the prefix of the complete RPX domain, so if your full domain 186 # is 'https://foo.rpxnow.com/', use 'foo' as the value of rpx-domain. 02a14d2 Added 'rpx' as authentication-method, 'rpx-domain' & 'rpx-key' config. jgm authored Mar 29, 2011 187 fe14fa8 Added functions for a password reset email. John MacFarlane authored Apr 23, 2009 188 mail-command: sendmail %s 189 # specifies the command to use to send notification emails. 190 # '%s' will be replaced by the destination email address. 191 # The body of the message will be read from stdin. 192 # If this field is left blank, password reset will not be offered. 193 194 reset-password-message: 195 > From: nobody@$hostname$ 196 > To: $useremail$ 197 > Subject: Wiki password reset 198 > 199 > Dear $username$: 200 > 201 > To reset your password, please follow the link below: 202 > http://$hostname$:$port$$resetlink 203 > 204 > Yours sincerely, 205 > The Wiki Master 206 207 # gives the text of the message that will be sent to the user should she 208 # want to reset her password, or change other registration info. 209 # The lines must be indented, and must begin with '>'. The initial 210 # spaces and '> ' will be stripped off. username will be replaced 211 # by the user's username, useremail by her email address, 212 # hostname by the hostname on which the wiki is running (as 213 # returned by the hostname system call), port by the port on 214 # which the wiki is running, and resetlink by the 215 # relative path of a reset link derived from the user's existing 216 # hashed password. If your gitit wiki is being proxied to a location 217 # other than the root path of port, you should change the link to 218 # reflect this: for example, to 219 # http://hostname/path/to/wikiresetlink or 220 # http://gitit.hostname$$resetlink$ 586399e Added atom feeds. jgm authored Jul 21, 2009 221 222 use-feed: no 223 # specifies whether an ATOM feed should be enabled (for the site and for 224 # individual pages) 225 226 base-url: 1bc9242 Use base-url to set rpx token_url. jgm authored Apr 6, 2011 227 # the base URL of the wiki, to be used in constructing feed IDs 228 # and RPX token_urls. Set this if use-feed is 'yes' or 229 # authentication-method is 'rpx'. 586399e Added atom feeds. jgm authored Jul 21, 2009 230 0b6ea00 Add the new configuration option 'absolute-urls'. David authored Jul 8, 2011 231 absolute-urls: no 232 # make wikilinks absolute with respect to the base-url. 233 # So, for example, in a wiki served at the base URL '/wiki', on a page 234 # Sub/Page, the wikilink '[Cactus]()' will produce a link to 235 # '/wiki/Cactus' if absolute-urls is 'yes', and a relative link to 'Cactus' 236 # (referring to '/wiki/Sub/Cactus') if absolute-urls is 'no'. 237 586399e Added atom feeds. jgm authored Jul 21, 2009 238 feed-days: 14 239 # number of days to be included in feeds. 240 241 feed-refresh-time: 60 242 # number of minutes to cache feeds before refreshing 52f586e Added PDF export and pdf-export config field. jgm authored Feb 19, 2010 243 244 pdf-export: no 245 # if yes, PDF will appear in export options. PDF will be created using 246 # pdflatex, which must be installed and in the path. Note that PDF 247 # exports create significant additional server load. 248 f0618b4 Added pandoc-user-data config option. jgm authored Feb 19, 2010 249 pandoc-user-data: 250 # if a directory is specified, this will be searched for pandoc 251 # customizations. These can include a templates/ directory for custom 252 # templates for various export formats, an S5 directory for custom 253 # S5 styles, and a reference.odt for ODT exports. If no directory is 254 # specified, \$HOME/.pandoc will be searched. See pandoc's README for 255 # more information. 256 8f3e8f5 Added xss-sanitize configuaration option. John MacFarlane authored Aug 27, 2011 257 xss-sanitize: yes 258 # if yes, all HTML (including that produced by pandoc) is filtered 259 # through xss-sanitize. Set to no only if you trust all of your users.