Mercurial > p > roundup > code

annotate templates/minimal/config.py @ 2119:cc4667ef3f12

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added the ability to toggle where error messages go. They either go to the user (default, for backwards compatibility), the dispatcher, or both. These are able to be toggled via settings in config.py. Please refer to upgrading.txt for more details. (And Richard, let me know if I've done anything wrong with this checkin. :))
author Eddie Parker <eparker@users.sourceforge.net>
date Thu, 25 Mar 2004 19:27:15 +0000
parents be047db3dd3d
children 702f9a6afdcf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1591
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 #
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 # This module is free software, and you may redistribute it and/or modify
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 # under the same terms as Python, so long as this copyright message and
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 # disclaimer are retained in their original form.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 #
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 # POSSIBILITY OF SUCH DAMAGE.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 #
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 #
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
18 # $Id: config.py,v 1.5 2004-03-25 19:27:15 eparker Exp $
1591
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 import os
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 # roundup home is this package's directory
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 TRACKER_HOME=os.path.split(__file__)[0]
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 # The SMTP mail host that roundup will use to send mail
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 MAILHOST = 'localhost'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
1612
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
28 # If your SMTP mail host requires a username and password for access, then
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
29 # specify them here.
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
30 # eg. MAILUSER = ('username', 'password')
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
31 MAILUSER = ()
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
32
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
33 # If your SMTP mail host provides or requires TLS (Transport Layer
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
34 # Security) then set MAILHOST_TLS = 'yes'
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
35 # Optionallly, you may also set MAILHOST_TLS_KEYFILE to the name of a PEM
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
36 # formatted file that contains your private key, and MAILHOST_TLS_CERTFILE
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
37 # to the name of a PEM formatted certificate chain file.
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
38 MAILHOST_TLS = 'no'
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
39 MAILHOST_TLS_KEYFILE = ''
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
40 MAILHOST_TLS_CERTFILE = ''
e109d59f232d SMTP login and TLS support added ([SF#710853] with extras ;)
Richard Jones <richard@users.sourceforge.net>
parents: 1591
diff changeset
41
1591
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 # The domain name used for email addresses.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 MAIL_DOMAIN = 'your.tracker.email.domain.example'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 # This is the directory that the database is going to be stored in
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 DATABASE = os.path.join(TRACKER_HOME, 'db')
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 # This is the directory that the HTML templates reside in
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 TEMPLATES = os.path.join(TRACKER_HOME, 'html')
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 # A descriptive name for your roundup instance
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 TRACKER_NAME = 'Roundup issue tracker'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 # The email address that mail to roundup should go to
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 # The web address that the tracker is viewable at. This will be included in
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 # information sent to users of the tracker. The URL MUST include the cgi-bin
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 # part or anything else that is required to get to the home page of the
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 # tracker. You MUST include a trailing '/' in the URL.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 TRACKER_WEB = 'http://tracker.example/cgi-bin/roundup.cgi/bugs/'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 # The email address that roundup will complain to if it runs into trouble
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
66 # The 'dispatcher' is a role that can get notified of new items to the database.
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
67 DISPATCHER_EMAIL = ADMIN_EMAIL
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
68
1591
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 # Additional text to include in the "name" part of the From: address used
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 # in nosy messages. If the sending user is "Foo Bar", the From: line is
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 # usually: "Foo Bar" <issue_tracker@tracker.example>
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 # the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 # "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74 EMAIL_FROM_TAG = ""
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 #
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 # SECURITY DEFINITIONS
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78 #
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 # define the Roles that a user gets when they register with the tracker
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80 # these are a comma-separated string of role names (e.g. 'Admin,User')
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 NEW_WEB_USER_ROLES = 'User'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 NEW_EMAIL_USER_ROLES = 'User'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
84 # Send error messages to the dispatcher, user, or both?
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
85 # If 'dispatcher', error message notifications will only be sent to the dispatcher.
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
86 # If 'user', error message notifications will only be sent to the user.
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
87 # If 'both', error message notifications will be sent to both individuals.
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
88 ERROR_MESSAGES_TO = 'user'
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2034
diff changeset
89
1591
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 # Send nosy messages to the author of the message
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91 MESSAGES_TO_AUTHOR = 'no' # either 'yes' or 'no'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 # Does the author of a message get placed on the nosy list automatically?
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94 # If 'new' is used, then the author will only be added when a message
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 # creates a new issue. If 'yes', then the author will be added on followups
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 # too. If 'no', they're never added to the nosy.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97 ADD_AUTHOR_TO_NOSY = 'new' # one of 'yes', 'no', 'new'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 # Do the recipients (To:, Cc:) of a message get placed on the nosy list?
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 # If 'new' is used, then the recipients will only be added when a message
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101 # creates a new issue. If 'yes', then the recipients will be added on followups
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102 # too. If 'no', they're never added to the nosy.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103 ADD_RECIPIENTS_TO_NOSY = 'new' # either 'yes', 'no', 'new'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 # Where to place the email signature
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106 EMAIL_SIGNATURE_POSITION = 'bottom' # one of 'top', 'bottom', 'none'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108 # Keep email citations when accepting messages. Setting this to "no" strips
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109 # out "quoted" text from the message. Signatures are also stripped.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110 EMAIL_KEEP_QUOTED_TEXT = 'yes' # either 'yes' or 'no'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 # Preserve the email body as is - that is, keep the citations _and_
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 # signatures.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114 EMAIL_LEAVE_BODY_UNCHANGED = 'no' # either 'yes' or 'no'
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116 # Default class to use in the mailgw if one isn't supplied in email
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 # subjects. To disable, comment out the variable below or leave it blank.
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118 # Examples:
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
119 MAIL_DEFAULT_CLASS = 'issue' # use "issue" class by default
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
120 #MAIL_DEFAULT_CLASS = '' # disable (or just comment the var out)
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121
1952
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1612
diff changeset
122 # HTML version to generate. The templates are html4 by default. If you
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1612
diff changeset
123 # wish to make them xhtml, then you'll need to change this var to 'xhtml'
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1612
diff changeset
124 # too so all auto-generated HTML is compliant.
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1612
diff changeset
125 HTML_VERSION = 'html4' # either 'html4' or 'xhtml'
c40ed9113285 Applied Stefan Seefeld's html4/xhtml patch with some changes.
Richard Jones <richard@users.sourceforge.net>
parents: 1612
diff changeset
126
2034
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
127 # Character set to encode email headers with. We use utf-8 by default, as
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
128 # it's the most flexible. Some mail readers (eg. Eudora) can't cope with
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
129 # that, so you might need to specify a more limited character set (eg.
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
130 # 'iso-8859-1'.
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
131 EMAIL_CHARSET = 'utf-8'
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
132 #EMAIL_CHARSET = 'iso-8859-1' # use this instead for Eudora users
be047db3dd3d Eudora can't handle utf-8 headers. We love Eudora. [SF#900046]
Richard Jones <richard@users.sourceforge.net>
parents: 1952
diff changeset
133
1591
21312a7564fd moving templates around
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
134 # vim: set filetype=python ts=4 sw=4 et si
Roundup Issue Tracker: http://roundup-tracker.org/