annotate roundup/templates/classic/config.py @ 1106:7c851d1521dc

better explanation
author Richard Jones <richard@users.sourceforge.net>
date Wed, 11 Sep 2002 01:18:42 +0000
parents fa7df238e2d4
children 0b44a351cf6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 #
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 # This module is free software, and you may redistribute it and/or modify
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 # under the same terms as Python, so long as this copyright message and
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 # disclaimer are retained in their original form.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 #
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
283bb1676d65 instance_config -> config
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
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 # POSSIBILITY OF SUCH DAMAGE.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 #
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 #
1106
7c851d1521dc better explanation
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
18 # $Id: config.py,v 1.3 2002-09-11 01:18:42 richard Exp $
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 import os
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 # roundup home is this package's directory
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1086
diff changeset
23 TRACKER_HOME=os.path.split(__file__)[0]
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 # The SMTP mail host that roundup will use to send mail
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 MAILHOST = 'localhost'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 # The domain name used for email addresses.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 MAIL_DOMAIN = 'your.tracker.email.domain.example'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 # This is the directory that the database is going to be stored in
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1086
diff changeset
32 DATABASE = os.path.join(TRACKER_HOME, 'db')
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 # This is the directory that the HTML templates reside in
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1086
diff changeset
35 TEMPLATES = os.path.join(TRACKER_HOME, 'html')
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 # A descriptive name for your roundup instance
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1086
diff changeset
38 TRACKER_NAME = 'Roundup issue tracker'
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 # The email address that mail to roundup should go to
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1086
diff changeset
41 TRACKER_EMAIL = 'issue_tracker@%s'%MAIL_DOMAIN
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 # The web address that the instance is viewable at
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1086
diff changeset
44 TRACKER_WEB = 'http://your.tracker.url.example/'
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 # The email address that roundup will complain to if it runs into trouble
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 ADMIN_EMAIL = 'roundup-admin@%s'%MAIL_DOMAIN
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 # Where to place the web filtering HTML on the index page
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 FILTER_POSITION = 'bottom' # one of 'top', 'bottom', 'top and bottom'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 #
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 # SECURITY DEFINITIONS
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 #
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 # define the Roles that a user gets when they register with the tracker
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 # these are a comma-separated string of role names (e.g. 'Admin,User')
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 NEW_WEB_USER_ROLES = 'User'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 NEW_EMAIL_USER_ROLES = 'User'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 # Send nosy messages to the author of the message
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 MESSAGES_TO_AUTHOR = 'no' # either 'yes' or 'no'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 # Does the author of a message get placed on the nosy list automatically?
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 # If 'new' is used, then the author will only be added when a message
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 # creates a new issue. If 'yes', then the author will be added on followups
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 # too. If 'no', they're never added to the nosy.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67 ADD_AUTHOR_TO_NOSY = 'new' # one of 'yes', 'no', 'new'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 # Do the recipients (To:, Cc:) of a message get placed on the nosy list?
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 # If 'new' is used, then the recipients will only be added when a message
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 # creates a new issue. If 'yes', then the recipients will be added on followups
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 # too. If 'no', they're never added to the nosy.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 ADD_RECIPIENTS_TO_NOSY = 'new' # either 'yes', 'no', 'new'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 # Where to place the email signature
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 EMAIL_SIGNATURE_POSITION = 'bottom' # one of 'top', 'bottom', 'none'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77
1106
7c851d1521dc better explanation
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
78 # Keep email citations when accepting messages. Setting this to "no" strips
7c851d1521dc better explanation
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
79 # out "quoted" text from the message. Signatures are also stripped.
7c851d1521dc better explanation
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
80 EMAIL_KEEP_QUOTED_TEXT = 'yes' # either 'yes' or 'no'
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81
1106
7c851d1521dc better explanation
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
82 # Preserve the email body as is - that is, keep the citations _and_
7c851d1521dc better explanation
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
83 # signatures.
1086
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84 EMAIL_LEAVE_BODY_UNCHANGED = 'no' # either 'yes' or 'no'
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 # Default class to use in the mailgw if one isn't supplied in email
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87 # subjects. To disable, comment out the variable below or leave it blank.
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 # Examples:
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 MAIL_DEFAULT_CLASS = 'issue' # use "issue" class by default
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 #MAIL_DEFAULT_CLASS = '' # disable (or just comment the var out)
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91
283bb1676d65 instance_config -> config
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 # vim: set filetype=python ts=4 sw=4 et si

Roundup Issue Tracker: http://roundup-tracker.org/