Mercurial > p > roundup > code
diff doc/customizing.txt @ 3922:586679a314f7
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 |
line wrap: on
line diff
--- a/doc/customizing.txt Wed Sep 26 03:07:55 2007 +0000 +++ b/doc/customizing.txt Wed Sep 26 03:20:21 2007 +0000 @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.221 $ +:Version: $Revision: 1.222 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -95,6 +95,14 @@ Path to the HTML templates directory. The path may be either absolute or relative to the directory containig this config file. + static_files -- default *blank* + Path to directory holding additional static files available via Web + UI. This directory may contain sitewide images, CSS stylesheets etc. + and is searched for these files prior to the TEMPLATES directory + specified above. If this option is not set, all static files are + taken from the TEMPLATES directory The path may be either absolute or + relative to the directory containig this config file. + admin_email -- ``roundup-admin`` Email address that roundup will complain to if it runs into trouble. If the email address doesn't contain an ``@`` part, the MAIL_DOMAIN defined @@ -150,6 +158,9 @@ your tracker. See the indexer source for the default list of stop-words (e.g. ``A,AND,ARE,AS,AT,BE,BUT,BY, ...``). + umask -- ``02`` + Defines the file creation mode mask. + Section **tracker** name -- ``Roundup issue tracker`` A descriptive name for your roundup instance. @@ -164,6 +175,11 @@ email -- ``issue_tracker`` Email address that mail to roundup should go to. + language -- default *blank* + Default locale name for this tracker. If this option is not set, the + language is determined by the environment variable LANGUAGE, LC_ALL, + LC_MESSAGES, or LANG, in that order of preference. + Section **web** http_auth -- ``yes`` Whether to use HTTP Basic Authentication, if present. @@ -204,6 +220,13 @@ password -- ``roundup`` Database user password. + read_default_file -- ``~/.my.cnf`` + Name of the MySQL defaults file. Only used in MySQL connections. + + read_default_group -- ``roundup`` + Name of the group to use in the MySQL defaults file. Only used in + MySQL connections. + Section **logging** config -- default *blank* Path to configuration file for standard Python logging module. If this @@ -277,6 +300,16 @@ precedence. The path may be either absolute or relative to the directory containig this config file. + add_authorinfo -- ``yes`` + Add a line with author information at top of all messages send by + roundup. + + add_authoremail -- ``yes`` + Add the mail address of the author to the author information at the + top of all messages. If this is false but add_authorinfo is true, + only the name of the actor is added which protects the mail address + of the actor from being exposed at mail archives, etc. + Section **mailgw** Roundup Mail Gateway options @@ -294,6 +327,10 @@ Default class to use in the mailgw if one isn't supplied in email subjects. To disable, leave the value blank. + language -- default *blank* + Default locale name for the tracker mail gateway. If this option is + not set, mail gateway will use the language of the tracker instance. + subject_prefix_parsing -- ``strict`` Controls the parsing of the [prefix] on subject lines in incoming emails. ``strict`` will return an error to the sender if the [prefix] is not @@ -319,6 +356,42 @@ an issue for the interval after the issue's creation or last activity. The interval is a standard Roundup interval. + refwd_re -- ``(\s*\W?\s*(fw|fwd|re|aw|sv|ang)\W)+`` + Regular expression matching a single reply or forward prefix + prepended by the mailer. This is explicitly stripped from the + subject during parsing. Value is Python Regular Expression + (UTF8-encoded). + + origmsg_re -- `` ^[>|\s]*-----\s?Original Message\s?-----$`` + Regular expression matching start of an original message if quoted + the in body. Value is Python Regular Expression (UTF8-encoded). + + sign_re -- ``^[>|\s]*-- ?$`` + Regular expression matching the start of a signature in the message + body. Value is Python Regular Expression (UTF8-encoded). + + eol_re -- ``[\r\n]+`` + Regular expression matching end of line. Value is Python Regular + Expression (UTF8-encoded). + + blankline_re -- ``[\r\n]+\s*[\r\n]+`` + Regular expression matching a blank line. Value is Python Regular + Expression (UTF8-encoded). + +Section **pgp** + OpenPGP mail processing options + + enable -- ``no`` + Enable PGP processing. Requires pyme. + + roles -- default *blank* + If specified, a comma-separated list of roles to perform PGP + processing on. If not specified, it happens for all users. + + homedir -- default *blank* + Location of PGP directory. Defaults to $HOME/.gnupg if not + specified. + Section **nosy** Nosy messages sending @@ -349,6 +422,12 @@ a separate email is sent to each recipient. If ``single`` then a single email is sent with each recipient as a CC address. + max_attachment_size -- ``2147483647`` + Attachments larger than the given number of bytes won't be attached + to nosy mails. They will be replaced by a link to the tracker's + download page for the file. + + You may generate a new default config file using the ``roundup-admin genconfig`` command.
