Mercurial > p > roundup > code

comparison doc/customizing.txt @ 1360:aa7e4e8b14be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
allow additional control over the roundupdb email sending... ...explicit cc addresses, different from address and different nosy list property. (thanks John Rouillard)
author Richard Jones <richard@users.sourceforge.net>
date Sun, 12 Jan 2003 00:41:27 +0000
parents b9b86428669a
children 4884fb0860f9
comparison
equal deleted inserted replaced
1359:ebfd8dd1cce7 1360:aa7e4e8b14be
1 =================== 1 ===================
2 Customising Roundup 2 Customising Roundup
3 =================== 3 ===================
4 4
5 :Version: $Revision: 1.68 $ 5 :Version: $Revision: 1.69 $
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::
105 105
106 **TRACKER_EMAIL** - ``'issue_tracker@%s'%MAIL_DOMAIN`` 106 **TRACKER_EMAIL** - ``'issue_tracker@%s'%MAIL_DOMAIN``
107 The email address that e-mail sent to roundup should go to. Think of it as the 107 The email address that e-mail sent to roundup should go to. Think of it as the
108 tracker's personal e-mail address. 108 tracker's personal e-mail address.
109 109
110 **TRACKER_WEB** - ``'http://your.tracker.url.example/'`` 110 **TRACKER_WEB** - ``'http://tracker.example/cgi-bin/roundup.cgi/bugs/'``
111 The web address that the tracker is viewable at. This will be included in 111 The web address that the tracker is viewable at. This will be included in
112 information sent to users of the tracker. The URL must include the cgi-bin 112 information sent to users of the tracker. The URL **must** include the
113 part or anything else that is required to get to the home page of the 113 cgi-bin part or anything else that is required to get to the home page of
114 tracker. You must include a trailing '/' in the URL. 114 the tracker. You **must** include a trailing '/' in the URL.
115 115
116 **ADMIN_EMAIL** - ``'roundup-admin@%s'%MAIL_DOMAIN`` 116 **ADMIN_EMAIL** - ``'roundup-admin@%s'%MAIL_DOMAIN``
117 The email address that roundup will complain to if it runs into trouble. 117 The email address that roundup will complain to if it runs into trouble.
118
119 **EMAIL_FROM_TAG** - ``''``
120 Additional text to include in the "name" part of the ``From:`` address used
121 in nosy messages. If the sending user is "Foo Bar", the ``From:`` line is
122 usually::
123 "Foo Bar" <issue_tracker@tracker.example>
124
125 the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so::
126
127 "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
118 128
119 **MESSAGES_TO_AUTHOR** - ``'yes'`` or``'no'`` 129 **MESSAGES_TO_AUTHOR** - ``'yes'`` or``'no'``
120 Send nosy messages to the author of the message. 130 Send nosy messages to the author of the message.
121 131
122 **ADD_AUTHOR_TO_NOSY** - ``'new'``, ``'yes'`` or ``'no'`` 132 **ADD_AUTHOR_TO_NOSY** - ``'new'``, ``'yes'`` or ``'no'``
170 TRACKER_NAME = 'Roundup issue tracker' 180 TRACKER_NAME = 'Roundup issue tracker'
171 181
172 # The email address that mail to roundup should go to 182 # The email address that mail to roundup should go to
173 TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN 183 TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
174 184
175 # The web address that the tracker is viewable at 185 # The web address that the tracker is viewable at. This will be included in
176 TRACKER_WEB = 'http://your.tracker.url.example/' 186 # information sent to users of the tracker. The URL MUST include the cgi-bin
187 # part or anything else that is required to get to the home page of the
188 # tracker. You MUST include a trailing '/' in the URL.
189 TRACKER_WEB = 'http://tracker.example/cgi-bin/roundup.cgi/bugs/'
177 190
178 # The email address that roundup will complain to if it runs into trouble 191 # The email address that roundup will complain to if it runs into trouble
179 ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN 192 ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
193
194 # Additional text to include in the "name" part of the From: address used
195 # in nosy messages. If the sending user is "Foo Bar", the From: line is
196 # usually: "Foo Bar" <issue_tracker@tracker.example>
197 # the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:
198 # "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
199 EMAIL_FROM_TAG = ""
180 200
181 # Send nosy messages to the author of the message 201 # Send nosy messages to the author of the message
182 MESSAGES_TO_AUTHOR = 'no' # either 'yes' or 'no' 202 MESSAGES_TO_AUTHOR = 'no' # either 'yes' or 'no'
183 203
184 # Does the author of a message get placed on the nosy list automatically? 204 # Does the author of a message get placed on the nosy list automatically?
205 # Default class to use in the mailgw if one isn't supplied in email 225 # Default class to use in the mailgw if one isn't supplied in email
206 # subjects. To disable, comment out the variable below or leave it blank. 226 # subjects. To disable, comment out the variable below or leave it blank.
207 # Examples: 227 # Examples:
208 MAIL_DEFAULT_CLASS = 'issue' # use "issue" class by default 228 MAIL_DEFAULT_CLASS = 'issue' # use "issue" class by default
209 #MAIL_DEFAULT_CLASS = '' # disable (or just comment the var out) 229 #MAIL_DEFAULT_CLASS = '' # disable (or just comment the var out)
230
231 #
232 # SECURITY DEFINITIONS
233 #
234 # define the Roles that a user gets when they register with the tracker
235 # these are a comma-separated string of role names (e.g. 'Admin,User')
236 NEW_WEB_USER_ROLES = 'User'
237 NEW_EMAIL_USER_ROLES = 'User'
210 238
211 Tracker Schema 239 Tracker Schema
212 ============== 240 ==============
213 241
214 Note: if you modify the schema, you'll most likely need to edit the 242 Note: if you modify the schema, you'll most likely need to edit the
Roundup Issue Tracker: http://roundup-tracker.org/