Mercurial > p > roundup > code

annotate doc/tracker_config.txt @ 7936:a9b136565838

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
feat: issue1525113 - notation to filter by logged-in user At long last (almost 18 years) this patch lands. It allows sharing of queries that want to use the currently logged in user (i.e. I or me). By replacing an id number for the user by '@current_user' in the query you can share the query for "my issues" where 'my' is the logged in user not the person who created the query. Updated the templates to use this. Updated upgrading.py for directions on using it. RDBMS and anydbm both work. Also expressions using it (e.g. not @current_user) work and are tested. Test code done. I am not sure what the change to templating.py does. I am following the original patch and have built a test case to hit the if clause. But the rest of the test doesn't actualy provide the props I need. If I knew what that code was supposed to do there I would create a real test.
author John Rouillard <rouilj@ieee.org>
date Mon, 06 May 2024 00:49:43 -0400
parents 6aa0525187cd
children 83a531e72e3e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
2 .. index:: config.ini; sections main
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
3
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
4 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
5
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
6 [main]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
7
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
8 # Database directory path.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
9 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
10 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
11 # Default: db
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
12 database = db
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
13
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
14 # Templating engine to use.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
15 # Possible values are:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
16 # 'zopetal' for the old TAL engine ported from Zope,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
17 # 'chameleon' for Chameleon,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
18 # 'jinja2' for jinja2 templating.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
19 # Available found jinja2 module.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
20 # Default: zopetal
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
21 template_engine = zopetal
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
22
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
23 # Path to the HTML templates directory.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
24 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
25 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
26 # Default: html
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
27 templates = html
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
28
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
29 # A list of space separated directory paths (or a single
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
30 # directory). These directories hold additional public
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
31 # static files available via Web UI. These directories
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
32 # may contain sitewide images, CSS stylesheets etc. If a
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
33 # '-' is included, the list processing ends and the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
34 # TEMPLATES directory is not searched after the specified
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
35 # directories. If this option is not set, all static
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
36 # files are taken from the TEMPLATES directory. Access to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
37 # these files is public, it is not checked against
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
38 # registered users. So do not put any sensitive data in
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
39 # the files in these directories.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
40 # The space separated paths may be either absolute
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
41 # or relative to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
42 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
43 static_files =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
44
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
45 # Email address that roundup will complain to if it runs
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
46 # into trouble.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
47 # If no domain is specified then the config item
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
48 # mail -> domain is added.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
49 # Default: roundup-admin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
50 admin_email = roundup-admin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
51
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
52 # The 'dispatcher' is a role that can get notified
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
53 # when errors occur while sending email to a user.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
54 # It is used by the ERROR_MESSAGES_TO config setting.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
55 # If no domain is specified then the config item
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
56 # mail -> domain is added.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
57 # Default: roundup-admin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
58 dispatcher_email = roundup-admin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
59
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
60 # Additional text to include in the "name" part
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
61 # of the From: address used in nosy messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
62 # If the sending user is "Foo Bar", the From: line
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
63 # is usually: "Foo Bar" <issue_tracker@tracker.example>
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
64 # the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
65 # "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
66 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
67 email_from_tag =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
68
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
69 # Roles that a user gets when they register
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
70 # with Web User Interface.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
71 # This is a comma-separated string of role names
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
72 # (e.g. 'Admin,User').
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
73 # Default: User
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
74 new_web_user_roles = User
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
75
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
76 # Roles that a user gets when they register
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
77 # with Email Gateway.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
78 # This is a comma-separated string of role names
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
79 # (e.g. 'Admin,User').
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
80 # Default: User
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
81 new_email_user_roles = User
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
82
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
83 # On schema changes, properties or classes in the history may
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
84 # become obsolete. Since normal access permissions do not apply
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
85 # (we don't know if a user should see such a property or class)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
86 # a list of roles is specified here that are allowed to see
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
87 # these obsolete properties in the history. By default only the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
88 # admin role may see these history entries, you can make them
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
89 # visible to all users by adding, e.g., the 'User' role here.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
90 # Default: Admin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
91 obsolete_history_roles = Admin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
92
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
93 # Send error message emails to the "dispatcher", "user",
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
94 # or "both" (these are the three allowed values).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
95 # The dispatcher is configured using the DISPATCHER_EMAIL
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
96 # setting.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
97 # Default: user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
98 error_messages_to = user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
99
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
100 # This setting should be left at the default value of html4.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
101 # Support is ending for xhtml mode.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
102 # HTML version to generate. The templates are html4 by default.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
103 # If you wish to make them xhtml, then you'll need to change
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
104 # this setting to 'xhtml' too so all auto-generated HTML
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
105 # is compliant.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
106 # Allowed values: html4, xhtml
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
107 # Default: html4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
108 html_version = html4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
109
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
110 # Default timezone offset,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
111 # applied when user's timezone is not set.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
112 # If pytz module is installed, value may be any valid
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
113 # timezone specification (e.g. EET or Europe/Warsaw).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
114 # If pytz is not installed, value must be integer number
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
115 # giving local timezone offset from UTC in hours.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
116 # Default: UTC
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
117 timezone = UTC
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
118
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
119 # Register new users instantly, or require confirmation via
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
120 # email?
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
121 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
122 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
123 instant_registration = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
124
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
125 # Offer registration confirmation by email or only
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
126 # through the web?
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
127 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
128 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
129 email_registration_confirmation = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
130
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
131 # Force Roundup to use a particular text indexer.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
132 # If no indexer is supplied, the first available indexer
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
133 # will be used in the following order:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
134 # Possible values: xapian, whoosh, native (internal), native-fts.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
135 # Note 'native-fts' will only be used if set.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
136 # Allowed values: '', 'xapian', 'whoosh', 'native', 'native-fts'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
137 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
138 indexer =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
139
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
140 # Used to determine what language should be used by the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
141 # indexer above. Applies to Xapian and PostgreSQL native-fts
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
142 # indexer. It sets the language for the stemmer, and PostgreSQL
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
143 # native-fts stopwords and other dictionaries.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
144 # Possible values: must be a valid language for the indexer,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
145 # see indexer documentation for details.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
146 # Default: english
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
147 indexer_language = english
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
148
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
149 # Additional stop-words for the full-text indexer specific to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
150 # your tracker. See the indexer source for the default list of
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
151 # stop-words (eg. A,AND,ARE,AS,AT,BE,BUT,BY, ...). This is
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
152 # not used by the postgres native-fts indexer. But is used to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
153 # filter search terms with the sqlite native-fts indexer.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
154 # Allowed values: comma-separated list of words
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
155 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
156 indexer_stopwords =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
157
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
158 # Defines the file creation mode mask.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
159 # Default: 0o2
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
160 umask = 0o2
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
161
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
162 # Maximum size of a csv-field during import. Roundups export
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
163 # format is a csv (comma separated values) variant. The csv
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
164 # reader has a limit on the size of individual fields
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
165 # starting with python 2.5. Set this to a higher value if you
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
166 # get the error 'Error: field larger than field limit' during
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
167 # import.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
168 # Default: 131072
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
169 csv_field_size = 131072
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
170
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
171 # Sets the default number of rounds used when encoding passwords
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
172 # using the PBKDF2 scheme. Set this to a higher value on faster
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
173 # systems which want more security.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
174 # PBKDF2 (Password-Based Key Derivation Function) is a
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
175 # password hashing mechanism that derives hash from the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
176 # password and a random salt. For authentication this process
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
177 # is repeated with the same salt as in the stored hash.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
178 # If both hashes match, the authentication succeeds.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
179 # PBKDF2 supports a variable 'rounds' parameter which varies
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
180 # the time-cost of calculating the hash - doubling the number
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
181 # of rounds doubles the cpu time required to calculate it. The
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
182 # purpose of this is to periodically adjust the rounds as CPUs
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
183 # become faster. The currently enforced minimum number of
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
184 # rounds is 1000.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
185 # See: http://en.wikipedia.org/wiki/PBKDF2 and RFC2898
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
186 # Default: 2000000
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
187 password_pbkdf2_default_rounds = 2000000
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
188
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
189 .. index:: config.ini; sections tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
190
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
191 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
192
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
193 [tracker]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
194
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
195 # A descriptive name for your roundup instance.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
196 # Default: Roundup issue tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
197 name = Roundup issue tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
198
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
199 # The web address that the tracker is viewable at.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
200 # This will be included in information
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
201 # sent to users of the tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
202 # The URL MUST include the cgi-bin part or anything else
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
203 # that is required to get to the home page of the tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
204 # URL MUST start with http/https scheme and end with '/'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
205 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
206 #web = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
207
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
208 # Email address that mail to roundup should go to.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
209 # If no domain is specified then mail_domain is added.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
210 # Default: issue_tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
211 email = issue_tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
212
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
213 # Controls the reply-to header address used when sending
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
214 # nosy messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
215 # If the value is unset (default) the roundup tracker's
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
216 # email address (above) is used.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
217 # If set to "AUTHOR" then the primary email address of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
218 # author of the change will be used as the reply-to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
219 # address. This allows email exchanges to occur outside of
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
220 # the view of roundup and exposes the address of the person
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
221 # who updated the issue, but it could be useful in some
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
222 # unusual circumstances.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
223 # If set to some other value, the value is used as the reply-to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
224 # address. It must be a valid RFC2822 address or people will not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
225 # be able to reply.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
226 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
227 replyto_address =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
228
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
229 # Default locale name for this tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
230 # If this option is not set, the language is determined
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
231 # by OS environment variable LANGUAGE, LC_ALL, LC_MESSAGES,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
232 # or LANG, in that order of preference.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
233 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
234 language =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
235
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
236 .. index:: config.ini; sections web
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
237
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
238 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
239
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
240 [web]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
241
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
242 # Setting this option enables Roundup to serve uploaded HTML
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
243 # file content *as HTML*. This is a potential security risk
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
244 # and is therefore disabled by default. Set to 'yes' if you
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
245 # trust *all* users uploading content to your tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
246 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
247 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
248 allow_html_file = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
249
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
250 # Whether to use HTTP Basic Authentication, if present.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
251 # Roundup will use either the REMOTE_USER (the value set
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
252 # by http_auth_header) or HTTP_AUTHORIZATION
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
253 # variables supplied by your web server (in that order).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
254 # Set this option to 'no' if you do not wish to use HTTP Basic
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
255 # Authentication in your web interface.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
256 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
257 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
258 http_auth = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
259
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
260 # The HTTP header that holds the user authentication information.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
261 # If empty (default) the REMOTE_USER header is used.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
262 # This is used when the upstream HTTP server authenticates
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
263 # the user and passes the username using this HTTP header.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
264 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
265 http_auth_header =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
266
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
267 # Setting this option makes roundup look at the Accept-Encoding
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
268 # header supplied by the client. It will compress the response
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
269 # on the fly using a common encoding. Disable it if your
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
270 # upstream server does compression of dynamic data.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
271 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
272 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
273 dynamic_compression = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
274
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
275 # Setting this option enables Roundup to serve precompressed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
276 # static files. The admin must create the compressed files with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
277 # proper extension (.gzip, .br, .zstd) in the same directory as
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
278 # the uncompressed file. If a precompressed file doesn't
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
279 # exist, the uncompressed file will be served possibly with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
280 # dynamic compression.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
281 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
282 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
283 use_precompressed_files = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
284
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
285 # If usernames consist of a name and a domain/realm part of
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
286 # the form user@realm and we're using REMOTE_USER for
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
287 # authentication (e.g. via Kerberos), convert the realm part
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
288 # of the incoming REMOTE_USER to lowercase before matching
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
289 # against the roundup username. This allows roundup usernames
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
290 # to be lowercase (including the realm) and still follow the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
291 # Kerberos convention of using an uppercase realm. In
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
292 # addition this is compatible with Active Directory which
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
293 # stores the username with realm as UserPrincipalName in
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
294 # lowercase.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
295 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
296 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
297 http_auth_convert_realm_to_lowercase = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
298
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
299 # If the http_auth option is in effect (see above)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
300 # we're accepting a REMOTE_USER variable resulting from
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
301 # an authentication mechanism implemented in the web-server,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
302 # e.g., Kerberos login or similar. To override the mechanism
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
303 # provided by the web-server (e.g. for enabling sub-login as
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
304 # another user) we tell roundup that the cookie takes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
305 # precedence over a REMOTE_USER or HTTP_AUTHORIZATION
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
306 # variable. So if both, a cookie and a REMOTE_USER is
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
307 # present, the cookie wins.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
308 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
309 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
310 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
311 cookie_takes_precedence = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
312
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
313 # Limit login attempts per user per minute to this number.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
314 # By default the 4th login attempt in a minute will notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
315 # the user that they need to wait 20 seconds before trying to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
316 # log in again. This limits password guessing attacks and
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
317 # shouldn't need to be changed. Rate limiting on login can
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
318 # be disabled by setting the value to 0.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
319 # Default: 3
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
320 login_attempts_min = 3
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
321
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
322 # The number of seconds needed to complete the new user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
323 # registration form. This limits the rate at which bots
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
324 # can attempt to sign up. Limit can be disabled by setting
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
325 # the value to 0.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
326 # Default: 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
327 registration_delay = 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
328
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
329 # When registering a user, check that the username
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
330 # is available before sending confirmation email.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
331 # Usually a username conflict is detected when
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
332 # confirming the registration. Disabled by default as
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
333 # it can be used for guessing existing usernames.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
334 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
335 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
336 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
337 registration_prevalidate_username = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
338
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
339 # Set the mode of the SameSite cookie option for
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
340 # the session cookie. Choices are 'Lax' or
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
341 # 'Strict'. 'None' can be used to suppress the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
342 # option. Strict mode provides additional security
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
343 # against CSRF attacks, but may confuse users who
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
344 # are logged into roundup and open a roundup link
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
345 # from a source other than roundup (e.g. link in
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
346 # email).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
347 # Allowed values: Strict, Lax, None
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
348 # Default: Lax
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
349 samesite_cookie_setting = Lax
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
350
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
351 # Whether to enable the XMLRPC API in the roundup web
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
352 # interface. By default the XMLRPC endpoint is the string
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
353 # 'xmlrpc' after the roundup web url configured in the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
354 # 'tracker' section. If this variable is set to 'no', the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
355 # xmlrpc path has no special meaning and will yield an
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
356 # error message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
357 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
358 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
359 enable_xmlrpc = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
360
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
361 # Whether to enable i18n for the xmlrpc endpoint. Enable it if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
362 # you want to enable translation based on browsers lang
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
363 # (if enabled), trackers lang (if set) or environment.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
364 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
365 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
366 translate_xmlrpc = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
367
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
368 # Whether to enable the REST API in the roundup web
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
369 # interface. By default the REST endpoint is the string
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
370 # 'rest' plus any additional REST-API parameters after the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
371 # roundup web url configured in the tracker section. If this
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
372 # variable is set to 'no', the rest path has no special meaning
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
373 # and will yield an error message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
374 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
375 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
376 enable_rest = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
377
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
378 # Whether to enable i18n for the rest endpoint. Enable it if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
379 # you want to enable translation based on browsers lang
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
380 # (if enabled), trackers lang (if set) or environment.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
381 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
382 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
383 translate_rest = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
384
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
385 # Log-Level for REST errors.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
386 # Allowed values: none, debug, info, warning, error, critical
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
387 # Default: none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
388 rest_logging = none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
389
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
390 # Limit API calls per api_interval_in_sec seconds to
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
391 # this number.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
392 # Determines the burst rate and the rate that new api
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
393 # calls will be made available. If set to 360 and
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
394 # api_intervals_in_sec is set to 3600, the 361st call in
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
395 # 10 seconds results in a 429 error to the caller. It
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
396 # tells them to wait 10 seconds (3600/360) before making
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
397 # another api request. A value of 0 turns off rate
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
398 # limiting in the API. Tune this as needed. See rest
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
399 # documentation for more info.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
400 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
401 # Default: 0
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
402 api_calls_per_interval = 0
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
403
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
404 # Defines the interval in seconds over which an api client can
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
405 # make api_calls_per_interval api calls. Tune this as needed.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
406 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
407 # Default: 3600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
408 api_interval_in_sec = 3600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
409
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
410 # Limit login failure to the API per api_failed_login_interval_in_sec
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
411 # seconds.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
412 # A value of 0 turns off failed login rate
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
413 # limiting in the API. You should not disable this. See rest
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
414 # documentation for more info.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
415 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
416 # Default: 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
417 api_failed_login_limit = 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
418
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
419 # Defines the interval in seconds over which api login failures
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
420 # are recorded. It allows api_failed_login_limit login failures
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
421 # in this time interval. Tune this as needed.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
422 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
423 # Default: 600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
424 api_failed_login_interval_in_sec = 600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
425
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
426 # How do we deal with @csrf fields in posted forms.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
427 # Set this to 'required' to block the post and notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
428 # the user if the field is missing or invalid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
429 # Set this to 'yes' to block the post and notify the user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
430 # if the token is invalid, but accept the form if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
431 # the field is missing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
432 # Set this to 'logfailure' to log a notice to the roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
433 # log if the field is invalid or missing, but accept
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
434 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
435 # Set this to 'no' to ignore the field and accept the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
436 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
437 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
438 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
439 csrf_enforce_token = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
440
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
441 # csrf_tokens have a limited lifetime. If they are not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
442 # used they are purged from the database after this
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
443 # number of minutes. Default (20160) is 2 weeks.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
444 # Default: 20160
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
445 csrf_token_lifetime = 20160
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
446
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
447 # This is only used for xmlrpc and rest requests. This test is
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
448 # done after Origin and Referer headers are checked. It only
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
449 # verifies that the X-Requested-With header exists. The value
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
450 # is ignored.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
451 # Set this to 'required' to block the post and notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
452 # the user if the header is missing or invalid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
453 # Set this to 'yes' is the same as required.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
454 # Set this to 'logfailure' is the same as 'no'.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
455 # Set this to 'no' to ignore the header and accept the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
456 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
457 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
458 csrf_enforce_header_x-requested-with = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
459
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
460 # Verify that the Referer http header matches the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
461 # tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
462 # Set this to 'required' to block the post and notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
463 # the user if the header is missing or invalid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
464 # Set this to 'yes' to block the post and notify the user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
465 # if the header is invalid, but accept the form if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
466 # the field is missing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
467 # Set this to 'logfailure' to log a notice to the roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
468 # log if the header is invalid or missing, but accept
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
469 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
470 # Set this to 'no' to ignore the header and accept the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
471 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
472 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
473 csrf_enforce_header_referer = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
474
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
475 # Verify that the Origin http header matches the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
476 # tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
477 # Set this to 'required' to block the post and notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
478 # the user if the header is missing or invalid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
479 # Set this to 'yes' to block the post and notify the user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
480 # if the header is invalid, but accept the form if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
481 # the field is missing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
482 # Set this to 'logfailure' to log a notice to the roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
483 # log if the header is invalid or missing, but accept
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
484 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
485 # Set this to 'no' to ignore the header and accept the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
486 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
487 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
488 csrf_enforce_header_origin = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
489
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
490 # A comma separated list of additonal valid Origin header
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
491 # values used when enforcing the header origin. They are used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
492 # only for the api URL's (/rest and /xmlrpc). They are not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
493 # used for the usual html URL's. These strings must match the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
494 # value of the Origin header exactly. So 'https://bar.edu' and
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
495 # 'https://Bar.edu' are two different Origin values. Note that
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
496 # the origin value is scheme://host. There is no path
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
497 # component. So 'https://bar.edu/' would never be valid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
498 # The value '*' can be used to match any origin. It must be
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
499 # first in the list if used. Note that this value allows
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
500 # any web page on the internet to make anonymous requests
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
501 # against your Roundup tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
502 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
503 # You need to set these if you have a web application on a
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
504 # different origin accessing your Roundup instance.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
505 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
506 # (The origin from the tracker.web setting in config.ini is
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
507 # always valid and does not need to be specified.)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
508 # A list of space separated case sensitive
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
509 # origin headers 'scheme://host'.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
510 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
511 allowed_api_origins =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
512
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
513 # Verify that the X-Forwarded-Host http header matches
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
514 # the host part of the tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
515 # Set this to 'required' to block the post and notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
516 # the user if the header is missing or invalid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
517 # Set this to 'yes' to block the post and notify the user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
518 # if the header is invalid, but accept the form if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
519 # the field is missing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
520 # Set this to 'logfailure' to log a notice to the roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
521 # log if the header is invalid or missing, but accept
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
522 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
523 # Set this to 'no' to ignore the header and accept the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
524 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
525 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
526 csrf_enforce_header_x-forwarded-host = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
527
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
528 # "If there is no X-Forward-Host header, verify that
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
529 # the Host http header matches the host part of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
530 # tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
531 # Set this to 'required' to block the post and notify
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
532 # the user if the header is missing or invalid.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
533 # Set this to 'yes' to block the post and notify the user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
534 # if the header is invalid, but accept the form if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
535 # the field is missing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
536 # Set this to 'logfailure' to log a notice to the roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
537 # log if the header is invalid or missing, but accept
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
538 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
539 # Set this to 'no' to ignore the header and accept the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
540 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
541 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
542 csrf_enforce_header_host = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
543
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
544 # Minimum number of header checks that must pass
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
545 # to accept the request. Set to 0 to accept post
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
546 # even if no header checks pass. Usually the Host header check
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
547 # always passes, so setting it less than 1 is not recommended.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
548 # Default: 1
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
549 csrf_header_min_count = 1
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
550
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
551 # Whether to use HTTP Accept-Language, if present.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
552 # Browsers send a language-region preference list.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
553 # It's usually set in the client's browser or in their
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
554 # Operating System.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
555 # Set this option to 'no' if you want to ignore it.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
556 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
557 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
558 use_browser_language = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
559
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
560 # Setting this option makes Roundup display error tracebacks
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
561 # in the user's browser rather than emailing them to the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
562 # tracker admin.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
563 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
564 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
565 debug = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
566
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
567 # Setting this option to yes/true allows users with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
568 # an empty/blank password to login to the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
569 # web/http interfaces.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
570 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
571 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
572 login_empty_passwords = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
573
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
574 # Setting this option makes Roundup migrate passwords with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
575 # an insecure password-scheme to a more secure scheme
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
576 # when the user logs in via the web-interface.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
577 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
578 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
579 migrate_passwords = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
580
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
581 # A per tracker secret used in etag calculations for
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
582 # an object. It must not be empty.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
583 # It prevents reverse engineering hidden data in an object
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
584 # by calculating the etag for a sample object. Then modifying
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
585 # hidden properties until the sample object's etag matches
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
586 # the one returned by roundup.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
587 # Changing this changes the etag and invalidates updates by
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
588 # clients. It must be persistent across application restarts.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
589 # (Note the default value changes every time
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
590 # roundup-admin updateconfig
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
591 # is run, so it must be explicitly set to a non-empty string.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
592 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
593 # A string that starts with 'file://' is interpreted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
594 # as a file path relative to the tracker home. Using
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
595 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
596 # line of the file will be used as the value. Any
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
597 # string that does not start with 'file://' is used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
598 # as is. It removes any whitespace at the end of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
599 # line, so a newline can be put in the file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
600 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
601 # Default: 3CpCdT9GrdQv7SCn24DTIQTwAoBguqhAopZnXRZA38w=
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
602 secret_key = 3CpCdT9GrdQv7SCn24DTIQTwAoBguqhAopZnXRZA38w=
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
603
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
604 # This is used to sign/validate json web tokens
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
605 # (JWT). Even if you don't use JWTs it must not be
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
606 # empty. You can use multiple secrets separated by a
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
607 # comma ','. This allows for secret rotation. The newest
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
608 # secret should be placed first and used for signing. The
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
609 # rest of the secrets are used for validating an old JWT.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
610 # If the first secret is less than 256 bits (32
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
611 # characters) in length JWTs are disabled. If other secrets
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
612 # are less than 32 chars, the application will exit. Removing
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
613 # a secret from this list invalidates all JWTs signed with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
614 # the secret. JWT support is experimental and disabled by
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
615 # default. The secrets must be persistent across
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
616 # application restarts.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
617 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
618 # A string that starts with 'file://' is interpreted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
619 # as a file path relative to the tracker home. Using
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
620 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
621 # line of the file will be used as the value. Any
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
622 # string that does not start with 'file://' is used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
623 # as is. It removes any whitespace at the end of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
624 # line, so a newline can be put in the file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
625 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
626 # Default: disabled
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
627 jwt_secret = disabled
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
628
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
629 .. index:: config.ini; sections rdbms
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
630
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
631 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
632
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
633 # Settings in this section (except for backend) are used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
634 # by RDBMS backends only.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
635 [rdbms]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
636
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
637 # Database backend.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
638 # Available backends: anydbm, mysql, sqlite, postgresql
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
639 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
640 #backend = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
641
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
642 # Name of the database to use. For Postgresql, this can
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
643 # be database.schema to use a specific schema within
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
644 # a Postgres database.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
645 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
646 name = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
647
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
648 # Database server host.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
649 # Default: localhost
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
650 host = localhost
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
651
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
652 # TCP port number of the database server.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
653 # Postgresql usually resides on port 5432 (if any),
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
654 # for MySQL default port number is 3306.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
655 # Leave this option empty to use backend default
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
656 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
657 port =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
658
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
659 # Database user name that Roundup should use.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
660 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
661 user = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
662
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
663 # Database user password.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
664 # A string that starts with 'file://' is interpreted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
665 # as a file path relative to the tracker home. Using
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
666 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
667 # line of the file will be used as the value. Any
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
668 # string that does not start with 'file://' is used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
669 # as is. It removes any whitespace at the end of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
670 # line, so a newline can be put in the file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
671 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
672 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
673 password = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
674
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
675 # Name of the PostgreSQL connection service for this Roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
676 # instance. Only used in Postgresql connections. You need to set
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
677 # up a pg_service.conf file usable by psql use this option.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
678 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
679 service =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
680
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
681 # Name of the MySQL defaults file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
682 # Only used in MySQL connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
683 # Default: ~/.my.cnf
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
684 read_default_file = ~/.my.cnf
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
685
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
686 # Name of the group to use in the MySQL defaults file (.my.cnf).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
687 # Only used in MySQL connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
688 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
689 read_default_group = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
690
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
691 # Charset to use for mysql connection and databases.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
692 # If set to 'default', no charset option is used when
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
693 # creating the db connection and utf8mb4 is used for the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
694 # database charset.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
695 # Otherwise any permissible mysql charset is allowed here.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
696 # Only used in MySQL connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
697 # Default: utf8mb4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
698 mysql_charset = utf8mb4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
699
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
700 # Comparison/order to use for mysql database/table collations.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
701 # When upgrading, you can use 'utf8' to match the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
702 # depricated 'utf8mb3'. This must be compatible with the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
703 # mysql_charset setting above. Only used by MySQL.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
704 # Default: utf8mb4_unicode_ci
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
705 mysql_collation = utf8mb4_unicode_ci
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
706
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
707 # Comparison/order to use for mysql database/table collations
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
708 # when matching case. When upgrading, you can use 'utf8_bin'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
709 # to match the depricated 'utf8mb3_bin' collation. This must
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
710 # be compatible with the mysql_collation above. Only used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
711 # by MySQL.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
712 # Default: utf8mb4_0900_bin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
713 mysql_binary_collation = utf8mb4_0900_bin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
714
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
715 # Number of seconds to wait when the SQLite database is locked
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
716 # Default: use a 30 second timeout (extraordinarily generous)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
717 # Only used in SQLite connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
718 # Default: 30
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
719 sqlite_timeout = 30
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
720
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
721 # Size of the node cache (in elements). Used to keep the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
722 # most recently used data in memory.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
723 # Default: 100
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
724 cache_size = 100
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
725
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
726 # Setting this option to 'no' protects the database against
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
727 # table creations.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
728 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
729 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
730 allow_create = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
731
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
732 # Setting this option to 'no' protects the database against
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
733 # table alterations.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
734 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
735 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
736 allow_alter = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
737
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
738 # Setting this option to 'no' protects the database against
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
739 # table drops.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
740 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
741 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
742 allow_drop = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
743
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
744 # Name of the PostgreSQL template for database creation.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
745 # For database creation the template used has to match
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
746 # the character encoding used (UTF8), there are different
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
747 # PostgreSQL installations using different templates with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
748 # different encodings. If you get an error:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
749 # new encoding (UTF8) is incompatible with the encoding of
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
750 # the template database (SQL_ASCII)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
751 # HINT: Use the same encoding as in the template database,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
752 # or use template0 as template.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
753 # then set this option to the template name given in the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
754 # error message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
755 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
756 template =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
757
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
758 # Database isolation level, currently supported for
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
759 # PostgreSQL and mysql. See, e.g.,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
760 # http://www.postgresql.org/docs/9.1/static/transaction-iso.html
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
761 # Allowed values: 'read uncommitted', 'read committed', 'repeatable read', 'serializable'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
762 # Default: read committed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
763 isolation_level = read committed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
764
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
765 # Set the database cursor for filter queries to serverside
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
766 # cursor, this avoids caching large amounts of data in the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
767 # client. This option only applies for the postgresql backend.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
768 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
769 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
770 serverside_cursor = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
771
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
772 .. index:: config.ini; sections sessiondb
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
773
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
774 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
775
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
776 # Choose configuration for session and one time key storage.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
777 [sessiondb]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
778
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
779 # Set backend for storing one time key (otk) and session data.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
780 # Values have to be compatible with main backend.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
781 # main\/ session>| anydbm | sqlite | redis | mysql | postgresql |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
782 # anydbm | D | | X | | |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
783 # sqlite | X | D | X | | |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
784 # mysql | | | | D | |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
785 # postgresql | | | | | D |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
786 # -------------------------------------------------------------+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
787 # D - default if unset, X - compatible choice
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
788 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
789 backend =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
790
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
791 # URL used to connect to redis. Default uses unauthenticated
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
792 # redis database 0 running on localhost with default port.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
793 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
794 # A string that starts with 'file://' is interpreted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
795 # as a file path relative to the tracker home. Using
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
796 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
797 # line of the file will be used as the value. Any
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
798 # string that does not start with 'file://' is used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
799 # as is. It removes any whitespace at the end of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
800 # line, so a newline can be put in the file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
801 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
802 # Default: redis://localhost:6379/0?health_check_interval=2
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
803 redis_url = redis://localhost:6379/0?health_check_interval=2
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
804
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
805 .. index:: config.ini; sections logging
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
806
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
807 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
808
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
809 [logging]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
810
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
811 # Path to configuration file for standard Python logging module.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
812 # If this option is set, logging configuration is loaded
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
813 # from specified file; options 'filename' and 'level'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
814 # in this section are ignored.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
815 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
816 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
817 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
818 config =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
819
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
820 # Log file name for minimal logging facility built into Roundup.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
821 # If no file name specified, log messages are written on stderr.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
822 # If above 'config' option is set, this option has no effect.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
823 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
824 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
825 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
826 filename =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
827
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
828 # Minimal severity level of messages written to log file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
829 # If above 'config' option is set, this option has no effect.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
830 # Allowed values: DEBUG, INFO, WARNING, ERROR
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
831 # Default: ERROR
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
832 level = ERROR
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
833
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
834 # If set to yes, only the loggers configured in this section will
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
835 # be used. Yes will disable gunicorn's --access-logfile.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
836 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
837 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
838 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
839 disable_loggers = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
840
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
841 .. index:: config.ini; sections mail
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
842
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
843 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
844
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
845 # Outgoing email options.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
846 # Used for nosy messages, password reset and registration approval
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
847 # requests.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
848 [mail]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
849
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
850 # The email domain that admin_email, issue_tracker and
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
851 # dispatcher_email belong to.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
852 # This domain is added to those config items if they don't
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
853 # explicitly include a domain.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
854 # Do not include the '@' symbol.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
855 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
856 #domain = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
857
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
858 # SMTP mail host that roundup will use to send mail
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
859 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
860 #host = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
861
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
862 # SMTP login name.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
863 # Set this if your mail host requires authenticated access.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
864 # If username is not empty, password (below) MUST be set!
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
865 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
866 username =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
867
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
868 # SMTP login password.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
869 # Set this if your mail host requires authenticated access.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
870 # A string that starts with 'file://' is interpreted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
871 # as a file path relative to the tracker home. Using
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
872 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
873 # line of the file will be used as the value. Any
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
874 # string that does not start with 'file://' is used
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
875 # as is. It removes any whitespace at the end of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
876 # line, so a newline can be put in the file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
877 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
878 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
879 #password = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
880
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
881 # Default port to send SMTP on.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
882 # Set this if your mail server runs on a different port.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
883 # Default: 25
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
884 port = 25
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
885
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
886 # The (fully qualified) host/ domain name (FQDN) to use during
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
887 # SMTP sessions. If left blank, the underlying SMTP library will
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
888 # attempt to detect your FQDN. Set this if your mail server
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
889 # requires something specific.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
890 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
891 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
892 local_hostname =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
893
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
894 # If your SMTP mail host provides or requires TLS
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
895 # (Transport Layer Security) then set this option to 'yes'.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
896 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
897 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
898 tls = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
899
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
900 # If TLS is used, you may set this option to the name
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
901 # of a PEM formatted file that contains your private key.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
902 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
903 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
904 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
905 tls_keyfile =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
906
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
907 # If TLS is used, you may set this option to the name
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
908 # of a PEM formatted certificate chain file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
909 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
910 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
911 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
912 tls_certfile =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
913
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
914 # Character set to encode email headers with.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
915 # We use utf-8 by default, as it's the most flexible.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
916 # Some mail readers (eg. Eudora) can't cope with that,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
917 # so you might need to specify a more limited character set
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
918 # (eg. iso-8859-1).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
919 # Default: utf-8
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
920 charset = utf-8
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
921
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
922 # Setting this option makes Roundup write all outgoing email
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
923 # messages to this file *instead* of sending them.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
924 # This option has the same effect as the environment variable
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
925 # SENDMAILDEBUG.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
926 # Environment variable takes precedence.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
927 # The path may be either absolute or relative
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
928 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
929 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
930 debug =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
931
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
932 # Add a line with author information at top of all messages
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
933 # sent by roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
934 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
935 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
936 add_authorinfo = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
937
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
938 # Add the mail address of the author to the author information
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
939 # at the top of all messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
940 # If this is false but add_authorinfo is true, only the name
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
941 # of the actor is added which protects the mail address of the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
942 # actor from being exposed at mail archives, etc.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
943 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
944 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
945 add_authoremail = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
946
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
947 .. index:: config.ini; sections mailgw
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
948
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
949 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
950
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
951 # Roundup Mail Gateway options
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
952 [mailgw]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
953
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
954 # Keep email citations when accepting messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
955 # Setting this to "no" strips out "quoted" text
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
956 # from the message. Setting this to "new" keeps quoted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
957 # text only if a new issue is being created.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
958 # Signatures are also stripped.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
959 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
960 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
961 keep_quoted_text = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
962
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
963 # Setting this to "yes" preserves the email body
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
964 # as is - that is, keep the citations _and_ signatures.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
965 # Setting this to "new" keeps the body only if we are
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
966 # creating a new issue.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
967 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
968 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
969 leave_body_unchanged = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
970
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
971 # Default class to use in the mailgw
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
972 # if one isn't supplied in email subjects.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
973 # To disable, leave the value blank.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
974 # Default: issue
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
975 default_class = issue
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
976
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
977 # Default locale name for the tracker mail gateway.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
978 # If this option is not set, mail gateway will use
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
979 # the language of the tracker instance.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
980 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
981 language =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
982
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
983 # Controls the parsing of the [prefix] on subject
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
984 # lines in incoming emails. "strict" will return an
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
985 # error to the sender if the [prefix] is not recognised.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
986 # "loose" will attempt to parse the [prefix] but just
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
987 # pass it through as part of the issue title if not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
988 # recognised. "none" will always pass any [prefix]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
989 # through as part of the issue title.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
990 # Default: strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
991 subject_prefix_parsing = strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
992
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
993 # Controls the parsing of the [suffix] on subject
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
994 # lines in incoming emails. "strict" will return an
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
995 # error to the sender if the [suffix] is not recognised.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
996 # "loose" will attempt to parse the [suffix] but just
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
997 # pass it through as part of the issue title if not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
998 # recognised. "none" will always pass any [suffix]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
999 # through as part of the issue title.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1000 # Default: strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1001 subject_suffix_parsing = strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1002
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1003 # Defines the brackets used for delimiting the prefix and
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1004 # suffix in a subject line. The presence of "suffix" in
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1005 # the config option name is a historical artifact and may
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1006 # be ignored.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1007 # Default: []
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1008 subject_suffix_delimiters = []
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1009
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1010 # Controls matching of the incoming email subject line
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1011 # against issue titles in the case where there is no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1012 # designator [prefix]. "never" turns off matching.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1013 # "creation + interval" or "activity + interval"
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1014 # will match an issue for the interval after the issue's
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1015 # creation or last activity. The interval is a standard
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1016 # Roundup interval.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1017 # Default: always
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1018 subject_content_match = always
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1019
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1020 # Update issue title if incoming subject of email is different.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1021 # Setting this to "no" will ignore the title part of the subject
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1022 # of incoming email messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1023 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1024 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1025 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1026 subject_updates_title = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1027
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1028 # Regular expression matching a single reply or forward
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1029 # prefix prepended by the mailer. This is explicitly
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1030 # stripped from the subject during parsing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1031 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1032 # Default: (\s*\W?\s*(fw|fwd|re|aw|sv|ang)\W)+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1033 refwd_re = (\s*\W?\s*(fw|fwd|re|aw|sv|ang)\W)+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1034
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1035 # Regular expression matching start of an original message
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1036 # if quoted the in body.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1037 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1038 # Default: ^[>|\s]*-----\s?Original Message\s?-----$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1039 origmsg_re = ^[>|\s]*-----\s?Original Message\s?-----$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1040
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1041 # Regular expression matching the start of a signature
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1042 # in the message body.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1043 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1044 # Default: ^[>|\s]*-- ?$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1045 sign_re = ^[>|\s]*-- ?$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1046
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1047 # Regular expression matching end of line.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1048 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1049 # Default: [\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1050 eol_re = [\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1051
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1052 # Regular expression matching a blank line.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1053 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1054 # Default: [\r\n]+\s*[\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1055 blankline_re = [\r\n]+\s*[\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1056
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1057 # Unpack attached messages (encoded as message/rfc822 in MIME)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1058 # as multiple parts attached as files to the issue, if not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1059 # set we handle message/rfc822 attachments as a single file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1060 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1061 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1062 unpack_rfc822 = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1063
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1064 # When parsing incoming mails, roundup uses the first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1065 # text/plain part it finds. If this part is inside a
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1066 # multipart/alternative, and this option is set, all other
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1067 # parts of the multipart/alternative are ignored. The default
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1068 # is to keep all parts and attach them to the issue.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1069 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1070 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1071 ignore_alternatives = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1072
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1073 # If an email has only text/html parts, use this module
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1074 # to convert the html to text. Choose from beautifulsoup 4,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1075 # dehtml - (internal code), or none to disable conversion.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1076 # If 'none' is selected, email without a text/plain part
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1077 # will be returned to the user with a message. If
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1078 # beautifulsoup is selected but not installed dehtml will
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1079 # be used instead.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1080 # Allowed values: beautifulsoup, dehtml, none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1081 # Default: none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1082 convert_htmltotext = none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1083
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1084 # When handling emails ignore the Resent-From:-header
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1085 # and use the original senders From:-header instead.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1086 # (This might be desirable in some situations where a moderator
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1087 # reads incoming messages first before bouncing them to Roundup)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1088 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1089 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1090 keep_real_from = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1091
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1092 .. index:: config.ini; sections pgp
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1093
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1094 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1095
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1096 # OpenPGP mail processing options
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1097 [pgp]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1098
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1099 # Enable PGP processing. Requires gpg. If you're planning
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1100 # to send encrypted PGP mail to the tracker, you should also
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1101 # enable the encrypt-option below, otherwise mail received
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1102 # encrypted might be sent unencrypted to another user.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1103 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1104 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1105 enable = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1106
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1107 # If specified, a comma-separated list of roles to perform
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1108 # PGP processing on. If not specified, it happens for all
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1109 # users. Note that received PGP messages (signed and/or
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1110 # encrypted) will be processed with PGP even if the user
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1111 # doesn't have one of the PGP roles, you can use this to make
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1112 # PGP processing completely optional by defining a role here
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1113 # and not assigning any users to that role.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1114 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1115 roles =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1116
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1117 # Location of PGP directory. Defaults to $HOME/.gnupg if
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1118 # not specified.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1119 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1120 homedir =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1121
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1122 # Enable PGP encryption. All outgoing mails are encrypted.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1123 # This requires that keys for all users (with one of the gpg
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1124 # roles above or all users if empty) are available. Note that
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1125 # it makes sense to educate users to also send mails encrypted
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1126 # to the tracker, to enforce this, set 'require_incoming'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1127 # option below (but see the note).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1128 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1129 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1130 encrypt = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1131
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1132 # Require that pgp messages received by roundup are either
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1133 # 'signed', 'encrypted' or 'both'. If encryption is required
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1134 # we do not return the message (in clear) to the user but just
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1135 # send an informational message that the message was rejected.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1136 # Note that this still presents known-plaintext to an attacker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1137 # when the users sends the mail a second time with encryption
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1138 # turned on.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1139 # Default: signed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1140 require_incoming = signed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1141
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1142 .. index:: config.ini; sections nosy
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1143
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1144 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1145
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1146 # Nosy messages sending
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1147 [nosy]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1148
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1149 # Send nosy messages to the author of the message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1150 # Allowed values: yes, no, new, nosy -- if yes, messages
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1151 # are sent to the author even if not on the nosy list, same
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1152 # for new (but only for new messages). When set to nosy,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1153 # the nosy list controls sending messages to the author.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1154 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1155 messages_to_author = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1156
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1157 # Where to place the email signature.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1158 # Allowed values: top, bottom, none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1159 # Default: bottom
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1160 signature_position = bottom
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1161
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1162 # Does the author of a message get placed on the nosy list
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1163 # automatically? If 'new' is used, then the author will
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1164 # only be added when a message creates a new issue.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1165 # If 'yes', then the author will be added on followups too.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1166 # If 'no', they're never added to the nosy.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1167 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1168 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1169 # Default: new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1170 add_author = new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1171
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1172 # Do the recipients (To:, Cc:) of a message get placed on the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1173 # nosy list? If 'new' is used, then the recipients will
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1174 # only be added when a message creates a new issue.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1175 # If 'yes', then the recipients will be added on followups too.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1176 # If 'no', they're never added to the nosy.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1177 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1178 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1179 # Default: new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1180 add_recipients = new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1181
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1182 # Controls the email sending from the nosy reactor. If
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1183 # "multiple" then a separate email is sent to each
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1184 # recipient. If "single" then a single email is sent with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1185 # each recipient as a CC address.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1186 # Default: single
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1187 email_sending = single
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1188
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1189 # Attachments larger than the given number of bytes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1190 # won't be attached to nosy mails. They will be replaced by
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1191 # a link to the tracker's download page for the file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1192 # Default: 9223372036854775807
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1193 max_attachment_size = 9223372036854775807
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1194
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1195 .. index:: config.ini; sections markdown
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1196
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1197 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1198
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1199 # Markdown rendering options.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1200 [markdown]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1201
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1202 # If yes/true, render single new line characters in markdown
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1203 # text with <br>. Set true if you want GitHub Flavored Markdown
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1204 # (GFM) handling of embedded newlines.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1205 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1206 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1207 break_on_newline = no
Roundup Issue Tracker: http://roundup-tracker.org/