Mercurial > p > roundup > code

comparison doc/customizing.txt @ 3922:586679a314f7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
role checking for PGP mail and docs Erik's suggestion to allow the admin to specify a set of roles to perform PGP processing on seemed like a reasonable one I implemented it. There is a new config option to control it. I also realized that the signature verification had a slight problem: it was simply checking for a valid, known signature before continuing on. If another user in the keyring forged mail it was pass the PGP check and then modify the db as the forged user. I changed the logic to make sure that the author of the email matches the key of the verifying signature. As I was adding the documentation for the PGP processing I noticed that there were several other new-ish options that didn't appear in customizing.txt so I added them as well.
author Justus Pendleton <jpend@users.sourceforge.net>
date Wed, 26 Sep 2007 03:20:21 +0000
parents 91008ec8f9a0
children 5857cd1a0db9
comparison
equal deleted inserted replaced
3921:b49bbd4ff6ea 3922:586679a314f7
1 =================== 1 ===================
2 Customising Roundup 2 Customising Roundup
3 =================== 3 ===================
4 4
5 :Version: $Revision: 1.221 $ 5 :Version: $Revision: 1.222 $
6 6
7 .. This document borrows from the ZopeBook section on ZPT. The original is at: 7 .. This document borrows from the ZopeBook section on ZPT. The original is at:
8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
9 9
10 .. contents:: 10 .. contents::
93 93
94 templates -- ``html`` 94 templates -- ``html``
95 Path to the HTML templates directory. The path may be either absolute 95 Path to the HTML templates directory. The path may be either absolute
96 or relative to the directory containig this config file. 96 or relative to the directory containig this config file.
97 97
98 static_files -- default *blank*
99 Path to directory holding additional static files available via Web
100 UI. This directory may contain sitewide images, CSS stylesheets etc.
101 and is searched for these files prior to the TEMPLATES directory
102 specified above. If this option is not set, all static files are
103 taken from the TEMPLATES directory The path may be either absolute or
104 relative to the directory containig this config file.
105
98 admin_email -- ``roundup-admin`` 106 admin_email -- ``roundup-admin``
99 Email address that roundup will complain to if it runs into trouble. If 107 Email address that roundup will complain to if it runs into trouble. If
100 the email address doesn't contain an ``@`` part, the MAIL_DOMAIN defined 108 the email address doesn't contain an ``@`` part, the MAIL_DOMAIN defined
101 below is used. 109 below is used.
102 110
148 indexer_stopwords -- default *blank* 156 indexer_stopwords -- default *blank*
149 Additional stop-words for the full-text indexer specific to 157 Additional stop-words for the full-text indexer specific to
150 your tracker. See the indexer source for the default list of 158 your tracker. See the indexer source for the default list of
151 stop-words (e.g. ``A,AND,ARE,AS,AT,BE,BUT,BY, ...``). 159 stop-words (e.g. ``A,AND,ARE,AS,AT,BE,BUT,BY, ...``).
152 160
161 umask -- ``02``
162 Defines the file creation mode mask.
163
153 Section **tracker** 164 Section **tracker**
154 name -- ``Roundup issue tracker`` 165 name -- ``Roundup issue tracker``
155 A descriptive name for your roundup instance. 166 A descriptive name for your roundup instance.
156 167
157 web -- ``http://host.example/demo/`` 168 web -- ``http://host.example/demo/``
161 that is required to get to the home page of the tracker. 172 that is required to get to the home page of the tracker.
162 You MUST include a trailing '/' in the URL. 173 You MUST include a trailing '/' in the URL.
163 174
164 email -- ``issue_tracker`` 175 email -- ``issue_tracker``
165 Email address that mail to roundup should go to. 176 Email address that mail to roundup should go to.
177
178 language -- default *blank*
179 Default locale name for this tracker. If this option is not set, the
180 language is determined by the environment variable LANGUAGE, LC_ALL,
181 LC_MESSAGES, or LANG, in that order of preference.
166 182
167 Section **web** 183 Section **web**
168 http_auth -- ``yes`` 184 http_auth -- ``yes``
169 Whether to use HTTP Basic Authentication, if present. 185 Whether to use HTTP Basic Authentication, if present.
170 Roundup will use either the REMOTE_USER or HTTP_AUTHORIZATION 186 Roundup will use either the REMOTE_USER or HTTP_AUTHORIZATION
202 Database user name that Roundup should use. 218 Database user name that Roundup should use.
203 219
204 password -- ``roundup`` 220 password -- ``roundup``
205 Database user password. 221 Database user password.
206 222
223 read_default_file -- ``~/.my.cnf``
224 Name of the MySQL defaults file. Only used in MySQL connections.
225
226 read_default_group -- ``roundup``
227 Name of the group to use in the MySQL defaults file. Only used in
228 MySQL connections.
229
207 Section **logging** 230 Section **logging**
208 config -- default *blank* 231 config -- default *blank*
209 Path to configuration file for standard Python logging module. If this 232 Path to configuration file for standard Python logging module. If this
210 option is set, logging configuration is loaded from specified file; 233 option is set, logging configuration is loaded from specified file;
211 options 'filename' and 'level' in this section are ignored. The path may 234 options 'filename' and 'level' in this section are ignored. The path may
275 to this file *instead* of sending them. This option has the same effect 298 to this file *instead* of sending them. This option has the same effect
276 as environment variable SENDMAILDEBUG. Environment variable takes 299 as environment variable SENDMAILDEBUG. Environment variable takes
277 precedence. The path may be either absolute or relative to the directory 300 precedence. The path may be either absolute or relative to the directory
278 containig this config file. 301 containig this config file.
279 302
303 add_authorinfo -- ``yes``
304 Add a line with author information at top of all messages send by
305 roundup.
306
307 add_authoremail -- ``yes``
308 Add the mail address of the author to the author information at the
309 top of all messages. If this is false but add_authorinfo is true,
310 only the name of the actor is added which protects the mail address
311 of the actor from being exposed at mail archives, etc.
312
280 Section **mailgw** 313 Section **mailgw**
281 Roundup Mail Gateway options 314 Roundup Mail Gateway options
282 315
283 keep_quoted_text -- ``yes`` 316 keep_quoted_text -- ``yes``
284 Keep email citations when accepting messages. Setting this to ``no`` strips 317 Keep email citations when accepting messages. Setting this to ``no`` strips
291 Allowed values: ``yes``, ``no`` 324 Allowed values: ``yes``, ``no``
292 325
293 default_class -- ``issue`` 326 default_class -- ``issue``
294 Default class to use in the mailgw if one isn't supplied in email subjects. 327 Default class to use in the mailgw if one isn't supplied in email subjects.
295 To disable, leave the value blank. 328 To disable, leave the value blank.
329
330 language -- default *blank*
331 Default locale name for the tracker mail gateway. If this option is
332 not set, mail gateway will use the language of the tracker instance.
296 333
297 subject_prefix_parsing -- ``strict`` 334 subject_prefix_parsing -- ``strict``
298 Controls the parsing of the [prefix] on subject lines in incoming emails. 335 Controls the parsing of the [prefix] on subject lines in incoming emails.
299 ``strict`` will return an error to the sender if the [prefix] is not 336 ``strict`` will return an error to the sender if the [prefix] is not
300 recognised. ``loose`` will attempt to parse the [prefix] but just 337 recognised. ``loose`` will attempt to parse the [prefix] but just
316 Controls matching of the incoming email subject line against issue titles 353 Controls matching of the incoming email subject line against issue titles
317 in the case where there is no designator [prefix]. ``never`` turns off 354 in the case where there is no designator [prefix]. ``never`` turns off
318 matching. ``creation + interval`` or ``activity + interval`` will match 355 matching. ``creation + interval`` or ``activity + interval`` will match
319 an issue for the interval after the issue's creation or last activity. 356 an issue for the interval after the issue's creation or last activity.
320 The interval is a standard Roundup interval. 357 The interval is a standard Roundup interval.
358
359 refwd_re -- ``(\s*\W?\s*(fw|fwd|re|aw|sv|ang)\W)+``
360 Regular expression matching a single reply or forward prefix
361 prepended by the mailer. This is explicitly stripped from the
362 subject during parsing. Value is Python Regular Expression
363 (UTF8-encoded).
364
365 origmsg_re -- `` ^[>|\s]*-----\s?Original Message\s?-----$``
366 Regular expression matching start of an original message if quoted
367 the in body. Value is Python Regular Expression (UTF8-encoded).
368
369 sign_re -- ``^[>|\s]*-- ?$``
370 Regular expression matching the start of a signature in the message
371 body. Value is Python Regular Expression (UTF8-encoded).
372
373 eol_re -- ``[\r\n]+``
374 Regular expression matching end of line. Value is Python Regular
375 Expression (UTF8-encoded).
376
377 blankline_re -- ``[\r\n]+\s*[\r\n]+``
378 Regular expression matching a blank line. Value is Python Regular
379 Expression (UTF8-encoded).
380
381 Section **pgp**
382 OpenPGP mail processing options
383
384 enable -- ``no``
385 Enable PGP processing. Requires pyme.
386
387 roles -- default *blank*
388 If specified, a comma-separated list of roles to perform PGP
389 processing on. If not specified, it happens for all users.
390
391 homedir -- default *blank*
392 Location of PGP directory. Defaults to $HOME/.gnupg if not
393 specified.
321 394
322 Section **nosy** 395 Section **nosy**
323 Nosy messages sending 396 Nosy messages sending
324 397
325 messages_to_author -- ``no`` 398 messages_to_author -- ``no``
346 419
347 email_sending -- ``single`` 420 email_sending -- ``single``
348 Controls the email sending from the nosy reactor. If ``multiple`` then 421 Controls the email sending from the nosy reactor. If ``multiple`` then
349 a separate email is sent to each recipient. If ``single`` then a single 422 a separate email is sent to each recipient. If ``single`` then a single
350 email is sent with each recipient as a CC address. 423 email is sent with each recipient as a CC address.
424
425 max_attachment_size -- ``2147483647``
426 Attachments larger than the given number of bytes won't be attached
427 to nosy mails. They will be replaced by a link to the tracker's
428 download page for the file.
429
351 430
352 You may generate a new default config file using the ``roundup-admin 431 You may generate a new default config file using the ``roundup-admin
353 genconfig`` command. 432 genconfig`` command.
354 433
355 Configuration variables may be referred to in lower or upper case. In code, 434 Configuration variables may be referred to in lower or upper case. In code,
Roundup Issue Tracker: http://roundup-tracker.org/