Mercurial > p > roundup > code

annotate doc/tracker_config.txt @ 8408:e882a5d52ae5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactor: move RateLimitExceeded to roundup.cgi.exceptions RateLimitExceeded is an HTTP exception that raises code 429. Move it to roundup.cgi.exceptions where all the other exceptions that result in http status codes are located. Also make it inherit from HTTPException since it is one. Also add docstrings for all HTTP exceptions and order HTTPExceptions by status code. BREAKING CHANGE: if somebody is importing RateLimitExceeded they will need to change their import. I consider it unlikely anybody is using RateLimitExceeded. Detectors and extensions are unlikely to raise RateLimitExceeded. So I am leaving it out of the upgrading doc. Just doc in change log.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Aug 2025 21:27:06 -0400
parents 6e44b3b20df2
children 520075b29474
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
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
3 .. _`config-ini-section-main`:
7920
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.
7986
83a531e72e3e update for 2.4.0 beta release
John Rouillard <rouilj@ieee.org>
parents: 7920
diff changeset
101 # Support for xhtml has been disabled.
7920
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.
7986
83a531e72e3e update for 2.4.0 beta release
John Rouillard <rouilj@ieee.org>
parents: 7920
diff changeset
103 # Allowed values: html4
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
104 # Default: html4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
105 html_version = html4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
106
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
107 # Default timezone offset,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
108 # 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
109 # 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
110 # 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
111 # 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
112 # 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
113 # Default: UTC
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
114 timezone = UTC
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
115
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
116 # 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
117 # email?
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
118 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
119 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
120 instant_registration = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
121
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
122 # Offer registration confirmation by email or only
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
123 # through the web?
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
124 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
125 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
126 email_registration_confirmation = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
127
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
128 # 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
129 # 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
130 # will be used in the following order:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
131 # 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
132 # 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
133 # Allowed values: '', 'xapian', 'whoosh', 'native', 'native-fts'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
134 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
135 indexer =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
136
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
137 # 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
138 # 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
139 # 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
140 # native-fts stopwords and other dictionaries.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
141 # 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
142 # see indexer documentation for details.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
143 # Default: english
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
144 indexer_language = english
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
145
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
146 # 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
147 # 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
148 # 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
149 # 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
150 # 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
151 # Allowed values: comma-separated list of words
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
152 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
153 indexer_stopwords =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
154
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
155 # Defines the file creation mode mask.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
156 # Default: 0o2
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
157 umask = 0o2
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
158
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
159 # 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
160 # 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
161 # 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
162 # 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
163 # 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
164 # import.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
165 # Default: 131072
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
166 csv_field_size = 131072
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
167
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
168 # Sets the default number of rounds used when encoding passwords
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
169 # using any PBKDF2 scheme. Set this to a higher value on faster
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
170 # systems which want more security. Use a minimum of 250000
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
171 # for PBKDF2-SHA512 which is the default hash in Roundup 2.5.
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
172 # 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
173 # 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
174 # 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
175 # 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
176 # If both hashes match, the authentication succeeds.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
177 # 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
178 # 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
179 # 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
180 # 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
181 # 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
182 # rounds is 1000.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
183 # See: http://en.wikipedia.org/wiki/PBKDF2 and RFC2898
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
184 # Default: 250000
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
185 password_pbkdf2_default_rounds = 250000
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
186
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
187 .. index:: config.ini; sections tracker
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
188 .. _`config-ini-section-tracker`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
189 .. code:: ini
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 [tracker]
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 # A descriptive name for your roundup instance.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
194 # Default: Roundup issue tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
195 name = Roundup issue tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
196
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
197 # 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
198 # This will be included in information
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
199 # sent to users of the tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
200 # 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
201 # 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
202 # 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
203 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
204 #web = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
205
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
206 # 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
207 # 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
208 # Default: issue_tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
209 email = issue_tracker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
210
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
211 # 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
212 # nosy messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
213 # 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
214 # email address (above) is used.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
215 # 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
216 # 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
217 # 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
218 # 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
219 # 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
220 # unusual circumstances.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
221 # 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
222 # 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
223 # be able to reply.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
224 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
225 replyto_address =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
226
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
227 # Default locale name for this tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
228 # 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
229 # 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
230 # or LANG, in that order of preference.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
231 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
232 language =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
233
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
234 .. index:: config.ini; sections web
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
235 .. _`config-ini-section-web`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
236 .. code:: ini
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 [web]
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 # 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
241 # 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
242 # 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
243 # 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
244 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
245 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
246 allow_html_file = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
247
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
248 # 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
249 # 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
250 # by http_auth_header) or HTTP_AUTHORIZATION
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
251 # 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
252 # 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
253 # Authentication in your web interface.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
254 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
255 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
256 http_auth = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
257
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
258 # 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
259 # 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
260 # 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
261 # 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
262 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
263 http_auth_header =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
264
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
265 # 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
266 # 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
267 # 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
268 # upstream server does compression of dynamic data.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
269 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
270 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
271 dynamic_compression = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
272
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
273 # 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
274 # 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
275 # 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
276 # 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
277 # 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
278 # dynamic compression.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
279 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
280 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
281 use_precompressed_files = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
282
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
283 # 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
284 # 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
285 # 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
286 # 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
287 # 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
288 # 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
289 # 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
290 # 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
291 # 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
292 # lowercase.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
293 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
294 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
295 http_auth_convert_realm_to_lowercase = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
296
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
297 # 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
298 # 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
299 # 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
300 # 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
301 # 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
302 # 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
303 # 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
304 # 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
305 # present, the cookie wins.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
306 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
307 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
308 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
309 cookie_takes_precedence = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
310
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
311 # 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
312 # 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
313 # 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
314 # 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
315 # 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
316 # 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
317 # Default: 3
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
318 login_attempts_min = 3
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
319
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
320 # 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
321 # 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
322 # 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
323 # the value to 0.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
324 # Default: 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
325 registration_delay = 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
326
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
327 # 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
328 # is available before sending confirmation email.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
329 # Usually a username conflict is detected when
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
330 # confirming the registration. Disabled by default as
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
331 # 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
332 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
333 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
334 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
335 registration_prevalidate_username = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
336
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
337 # 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
338 # the session cookie. Choices are 'Lax' or
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
339 # '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
340 # option. Strict mode provides additional security
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
341 # 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
342 # 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
343 # 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
344 # email).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
345 # Allowed values: Strict, Lax, None
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
346 # Default: Lax
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
347 samesite_cookie_setting = Lax
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
348
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
349 # 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
350 # 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
351 # '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
352 # '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
353 # 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
354 # error message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
355 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
356 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
357 enable_xmlrpc = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
358
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
359 # 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
360 # 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
361 # (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
362 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
363 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
364 translate_xmlrpc = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
365
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
366 # 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
367 # 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
368 # '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
369 # 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
370 # 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
371 # and will yield an error message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
372 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
373 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
374 enable_rest = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
375
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
376 # 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
377 # 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
378 # (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
379 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
380 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
381 translate_rest = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
382
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
383 # Log-Level for REST errors.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
384 # 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
385 # Default: none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
386 rest_logging = none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
387
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
388 # 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
389 # this number.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
390 # 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
391 # 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
392 # 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
393 # 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
394 # 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
395 # 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
396 # 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
397 # documentation for more info.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
398 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
399 # Default: 0
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
400 api_calls_per_interval = 0
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
401
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
402 # 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
403 # 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
404 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
405 # Default: 3600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
406 api_interval_in_sec = 3600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
407
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
408 # 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
409 # seconds.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
410 # 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
411 # 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
412 # documentation for more info.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
413 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
414 # Default: 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
415 api_failed_login_limit = 4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
416
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
417 # 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
418 # 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
419 # 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
420 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
421 # Default: 600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
422 api_failed_login_interval_in_sec = 600
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
423
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
424 # 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
425 # 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
426 # 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
427 # 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
428 # 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
429 # the field is missing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
430 # 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
431 # 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
432 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
433 # 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
434 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
435 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
436 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
437 csrf_enforce_token = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
438
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
439 # 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
440 # 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
441 # 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
442 # Default: 20160
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
443 csrf_token_lifetime = 20160
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
444
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
445 # 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
446 # 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
447 # 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
448 # is ignored.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
449 # 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
450 # 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
451 # 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
452 # 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
453 # 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
454 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
455 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
456 csrf_enforce_header_x-requested-with = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
457
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
458 # 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
459 # tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
460 # 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
461 # 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
462 # 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
463 # if the header is invalid, but accept the form if
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
464 # the header is missing.
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
465 # 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
466 # 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
467 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
468 # 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
469 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
470 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
471 csrf_enforce_header_referer = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
472
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
473 # 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
474 # tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
475 # 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
476 # 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
477 # 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
478 # if the header is invalid, but accept the form if
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
479 # the header is missing.
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
480 # 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
481 # 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
482 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
483 # 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
484 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
485 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
486 csrf_enforce_header_origin = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
487
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
488 # 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
489 # 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
490 # 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
491 # 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
492 # 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
493 # '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
494 # 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
495 # 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
496 # 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
497 # 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
498 # 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
499 # against your Roundup tracker.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
500 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
501 # 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
502 # different origin accessing your Roundup instance.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
503 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
504 # (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
505 # 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
506 # A list of space separated case sensitive
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
507 # origin headers 'scheme://host'.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
508 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
509 allowed_api_origins =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
510
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
511 # 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
512 # 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
513 # 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
514 # 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
515 # 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
516 # if the header is invalid, but accept the form if
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
517 # the header is missing.
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
518 # 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
519 # 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
520 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
521 # 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
522 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
523 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
524 csrf_enforce_header_x-forwarded-host = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
525
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
526 # "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
527 # 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
528 # tracker.web setting in config.ini.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
529 # 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
530 # 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
531 # 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
532 # if the header is invalid, but accept the form if
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
533 # the header is missing.
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
534 # 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
535 # 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
536 # the post.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
537 # 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
538 # Allowed values: required, yes, logfailure, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
539 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
540 csrf_enforce_header_host = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
541
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
542 # 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
543 # 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
544 # 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
545 # 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
546 # Default: 1
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
547 csrf_header_min_count = 1
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
548
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
549 # 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
550 # Browsers send a language-region preference list.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
551 # 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
552 # Operating System.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
553 # 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
554 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
555 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
556 use_browser_language = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
557
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
558 # 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
559 # 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
560 # tracker admin.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
561 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
562 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
563 debug = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
564
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
565 # 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
566 # 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
567 # web/http interfaces.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
568 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
569 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
570 login_empty_passwords = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
571
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
572 # 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
573 # 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
574 # 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
575 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
576 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
577 migrate_passwords = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
578
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
579 # 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
580 # an object. It must not be empty.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
581 # 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
582 # 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
583 # 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
584 # the one returned by roundup.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
585 # 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
586 # 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
587 # (Note the default value changes every time
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
588 # roundup-admin updateconfig
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
589 # 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
590 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
591 # 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
592 # 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
593 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
594 # 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
595 # 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
596 # 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
597 # 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
598 #
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
599 # Default: DWmbKgVUy6fF5D2Y5TD5Az+dnHhMYKCCpJzIY3H8nsU=
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
600 secret_key = DWmbKgVUy6fF5D2Y5TD5Az+dnHhMYKCCpJzIY3H8nsU=
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
601
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
602 # 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
603 # (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
604 # 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
605 # 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
606 # 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
607 # 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
608 # 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
609 # 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
610 # 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
611 # 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
612 # 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
613 # default. The secrets must be persistent across
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
614 # application restarts.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
615 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
616 # 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
617 # 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
618 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
619 # 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
620 # 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
621 # 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
622 # 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
623 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
624 # Default: disabled
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
625 jwt_secret = disabled
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
626
8300
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
627 # HTML input elements for Date properties: This determines
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
628 # if we use the input type 'datetime-local' (or 'date') for
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
629 # date input fields. If the option is turned off (the default),
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
630 # the type is set to 'text'. Since the widgets generated by
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
631 # browsers determine the date format from the language
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
632 # setting (it is currently not possible to force the
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
633 # international date format server-side) and some browsers
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
634 # ignore the date format set by the operating system, the
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
635 # default is 'no'.
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
636 # Allowed values: yes, no
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
637 # Default: no
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
638 use_browser_date_input = no
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
639
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
640 # HTML input elements for Number properties: This determines
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
641 # if we use the input type 'number' for Number (and Integer)
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
642 # properties. If set to 'no' we use input type 'text'.
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
643 # Allowed values: yes, no
8340
6e44b3b20df2 docs: update generated tracker_config.txt. Default is to not use native html number type
John Rouillard <rouilj@ieee.org>
parents: 8300
diff changeset
644 # Default: no
8300
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
645 use_browser_number_input = no
b99e76e76496 Make native date and number elements configurable
Ralf Schlatterbeck <rsc@runtux.com>
parents: 8274
diff changeset
646
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
647 .. index:: config.ini; sections rdbms
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
648 .. _`config-ini-section-rdbms`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
649 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
650
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
651
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
652 # Most settings in this section (except for backend and debug_filter)
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
653 # are used by RDBMS backends only.
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
654
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
655 [rdbms]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
656
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
657 # Database backend.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
658 # Available backends: anydbm, mysql, sqlite, postgresql
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
659 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
660 #backend = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
661
8274
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
662 # Filter debugging: Permissions can define additional filter
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
663 # functions that are used when checking permissions on results
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
664 # returned by the database. This is done to improve
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
665 # performance since the filtering is done in the database
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
666 # backend, not in python (at least for the SQL backends). The
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
667 # user is responsible for making the filter return the same
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
668 # set of results as the check function for a permission. So it
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
669 # makes sense to aid in debugging (and performance
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
670 # measurements) to allow turning off the usage of filter
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
671 # functions using only the check functions.
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
672 # Allowed values: yes, no
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
673 # Default: no
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
674 debug_filter = no
c3bf229d3d4b doc: update tracker_config.txt
John Rouillard <rouilj@ieee.org>
parents: 8036
diff changeset
675
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
676 # 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
677 # 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
678 # a Postgres database.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
679 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
680 name = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
681
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
682 # Database server host.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
683 # Default: localhost
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
684 host = localhost
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 # TCP port number of the database server.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
687 # 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
688 # for MySQL default port number is 3306.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
689 # 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
690 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
691 port =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
692
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
693 # Database user name that Roundup should use.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
694 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
695 user = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
696
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
697 # Database user password.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
698 # 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
699 # 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
700 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
701 # 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
702 # 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
703 # 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
704 # 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
705 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
706 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
707 password = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
708
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
709 # 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
710 # 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
711 # 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
712 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
713 service =
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 # Name of the MySQL defaults file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
716 # Only used in MySQL connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
717 # Default: ~/.my.cnf
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
718 read_default_file = ~/.my.cnf
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
719
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
720 # 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
721 # Only used in MySQL connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
722 # Default: roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
723 read_default_group = roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
724
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
725 # 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
726 # 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
727 # 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
728 # database charset.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
729 # 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
730 # Only used in MySQL connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
731 # Default: utf8mb4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
732 mysql_charset = utf8mb4
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
733
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
734 # 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
735 # 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
736 # 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
737 # 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
738 # Default: utf8mb4_unicode_ci
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
739 mysql_collation = utf8mb4_unicode_ci
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
740
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
741 # 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
742 # 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
743 # 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
744 # 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
745 # by MySQL.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
746 # Default: utf8mb4_0900_bin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
747 mysql_binary_collation = utf8mb4_0900_bin
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
748
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
749 # 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
750 # 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
751 # Only used in SQLite connections.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
752 # Default: 30
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
753 sqlite_timeout = 30
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
754
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
755 # 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
756 # most recently used data in memory.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
757 # Default: 100
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
758 cache_size = 100
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
759
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
760 # 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
761 # table creations.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
762 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
763 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
764 allow_create = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
765
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
766 # 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
767 # table alterations.
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 allow_alter = 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 # 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
773 # table drops.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
774 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
775 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
776 allow_drop = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
777
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
778 # 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
779 # 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
780 # 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
781 # PostgreSQL installations using different templates with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
782 # different encodings. If you get an error:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
783 # 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
784 # the template database (SQL_ASCII)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
785 # 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
786 # or use template0 as template.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
787 # 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
788 # error message.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
789 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
790 template =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
791
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
792 # Database isolation level, currently supported for
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
793 # PostgreSQL and mysql. See, e.g.,
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
794 # 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
795 # 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
796 # Default: read committed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
797 isolation_level = read committed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
798
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
799 # 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
800 # 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
801 # 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
802 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
803 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
804 serverside_cursor = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
805
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
806 .. index:: config.ini; sections sessiondb
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
807 .. _`config-ini-section-sessiondb`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
808 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
809
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
810
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
811 # Choose configuration for session and one time key storage.
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
812
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
813 [sessiondb]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
814
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
815 # 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
816 # 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
817 # main\/ session>| anydbm | sqlite | redis | mysql | postgresql |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
818 # anydbm | D | | X | | |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
819 # sqlite | X | D | X | | |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
820 # mysql | | | | D | |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
821 # postgresql | | | | | D |
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
822 # -------------------------------------------------------------+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
823 # D - default if unset, X - compatible choice
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
824 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
825 backend =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
826
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
827 # 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
828 # 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
829 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
830 # 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
831 # 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
832 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
833 # 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
834 # 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
835 # 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
836 # 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
837 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
838 # 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
839 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
840
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
841 .. index:: config.ini; sections logging
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
842 .. _`config-ini-section-logging`:
7920
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 [logging]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
846
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
847 # 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
848 # 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
849 # from specified file; options 'filename' and 'level'
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
850 # in this section are ignored.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
851 # 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
852 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
853 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
854 config =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
855
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
856 # 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
857 # 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
858 # 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
859 # 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
860 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
861 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
862 filename =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
863
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
864 # 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
865 # 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
866 # Allowed values: DEBUG, INFO, WARNING, ERROR
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
867 # Default: ERROR
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
868 level = ERROR
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
869
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
870 # 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
871 # 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
872 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
873 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
874 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
875 disable_loggers = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
876
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
877 .. index:: config.ini; sections mail
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
878 .. _`config-ini-section-mail`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
879 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
880
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
881
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
882 # Outgoing email options.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
883 # 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
884 # requests.
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
885
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
886 [mail]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
887
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
888 # 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
889 # dispatcher_email belong to.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
890 # 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
891 # explicitly include a domain.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
892 # Do not include the '@' symbol.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
893 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
894 #domain = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
895
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
896 # 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
897 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
898 #host = NO DEFAULT
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 # SMTP login name.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
901 # 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
902 # 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
903 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
904 username =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
905
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
906 # SMTP login password.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
907 # 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
908 # 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
909 # 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
910 # 'file:///' defines an absolute path. The first
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
911 # 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
912 # 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
913 # 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
914 # 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
915 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
916 # Default: NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
917 #password = NO DEFAULT
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
918
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
919 # Default port to send SMTP on.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
920 # 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
921 # Default: 25
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
922 port = 25
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
923
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
924 # 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
925 # 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
926 # 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
927 # requires something specific.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
928 #
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 local_hostname =
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 # 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
933 # (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
934 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
935 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
936 tls = no
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 # 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
939 # 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
940 # 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
941 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
942 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
943 tls_keyfile =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
944
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
945 # 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
946 # of a PEM formatted certificate chain file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
947 # 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
948 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
949 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
950 tls_certfile =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
951
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
952 # Character set to encode email headers with.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
953 # 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
954 # 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
955 # 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
956 # (eg. iso-8859-1).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
957 # Default: utf-8
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
958 charset = utf-8
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
959
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
960 # 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
961 # 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
962 # 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
963 # SENDMAILDEBUG.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
964 # Environment variable takes precedence.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
965 # 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
966 # to the directory containing this config file.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
967 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
968 debug =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
969
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
970 # 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
971 # sent by roundup
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
972 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
973 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
974 add_authorinfo = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
975
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
976 # 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
977 # at the top of all messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
978 # 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
979 # 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
980 # 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
981 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
982 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
983 add_authoremail = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
984
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
985 .. index:: config.ini; sections mailgw
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
986 .. _`config-ini-section-mailgw`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
987 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
988
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
989
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
990 # Roundup Mail Gateway options
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
991
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
992 [mailgw]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
993
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
994 # Keep email citations when accepting messages.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
995 # 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
996 # 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
997 # 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
998 # Signatures are also stripped.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
999 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1000 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1001 keep_quoted_text = yes
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 # 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
1004 # 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
1005 # 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
1006 # creating a new issue.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1007 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1008 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1009 leave_body_unchanged = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1010
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1011 # Default class to use in the mailgw
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1012 # 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
1013 # To disable, leave the value blank.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1014 # Default: issue
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1015 default_class = issue
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1016
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1017 # 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
1018 # 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
1019 # the language of the tracker instance.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1020 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1021 language =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1022
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1023 # 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
1024 # 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
1025 # 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
1026 # "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
1027 # 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
1028 # recognised. "none" will always pass any [prefix]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1029 # through as part of the issue title.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1030 # Default: strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1031 subject_prefix_parsing = strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1032
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1033 # 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
1034 # 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
1035 # 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
1036 # "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
1037 # 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
1038 # recognised. "none" will always pass any [suffix]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1039 # through as part of the issue title.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1040 # Default: strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1041 subject_suffix_parsing = strict
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1042
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1043 # 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
1044 # 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
1045 # 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
1046 # be ignored.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1047 # Default: []
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1048 subject_suffix_delimiters = []
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1049
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1050 # 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
1051 # 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
1052 # designator [prefix]. "never" turns off matching.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1053 # "creation + interval" or "activity + interval"
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1054 # 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
1055 # 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
1056 # Roundup interval.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1057 # Default: always
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1058 subject_content_match = always
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1059
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1060 # 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
1061 # 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
1062 # of incoming email messages.
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 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1065 # Default: yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1066 subject_updates_title = yes
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1067
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1068 # 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
1069 # 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
1070 # stripped from the subject during parsing.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1071 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1072 # 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
1073 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
1074
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1075 # 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
1076 # if quoted the in body.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1077 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1078 # Default: ^[>|\s]*-----\s?Original Message\s?-----$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1079 origmsg_re = ^[>|\s]*-----\s?Original Message\s?-----$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1080
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1081 # 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
1082 # in the message body.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1083 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1084 # Default: ^[>|\s]*-- ?$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1085 sign_re = ^[>|\s]*-- ?$
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1086
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1087 # Regular expression matching end of line.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1088 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1089 # Default: [\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1090 eol_re = [\r\n]+
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 # Regular expression matching a blank line.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1093 # Value is Python Regular Expression (UTF8-encoded).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1094 # Default: [\r\n]+\s*[\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1095 blankline_re = [\r\n]+\s*[\r\n]+
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1096
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1097 # 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
1098 # 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
1099 # 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
1100 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1101 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1102 unpack_rfc822 = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1103
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1104 # 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
1105 # 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
1106 # 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
1107 # 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
1108 # 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
1109 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1110 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1111 ignore_alternatives = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1112
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1113 # 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
1114 # 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
1115 # 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
1116 # 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
1117 # 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
1118 # 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
1119 # be used instead.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1120 # Allowed values: beautifulsoup, dehtml, none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1121 # Default: none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1122 convert_htmltotext = none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1123
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1124 # 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
1125 # 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
1126 # (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
1127 # 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
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 keep_real_from = 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 .. index:: config.ini; sections pgp
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1133 .. _`config-ini-section-pgp`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1134 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1135
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1136
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1137 # OpenPGP mail processing options
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1138
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1139 [pgp]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1140
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1141 # 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
1142 # 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
1143 # 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
1144 # 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
1145 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1146 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1147 enable = no
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 # 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
1150 # 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
1151 # 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
1152 # 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
1153 # 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
1154 # 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
1155 # 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
1156 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1157 roles =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1158
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1159 # 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
1160 # not specified.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1161 # Default:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1162 homedir =
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1163
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1164 # 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
1165 # 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
1166 # 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
1167 # 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
1168 # 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
1169 # option below (but see the note).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1170 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1171 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1172 encrypt = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1173
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1174 # 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
1175 # '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
1176 # 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
1177 # 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
1178 # 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
1179 # 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
1180 # turned on.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1181 # Default: signed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1182 require_incoming = signed
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1183
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1184 .. index:: config.ini; sections nosy
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1185 .. _`config-ini-section-nosy`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1186 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1187
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1188
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1189 # Nosy messages sending
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1190
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1191 [nosy]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1192
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1193 # 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
1194 # 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
1195 # 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
1196 # 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
1197 # 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
1198 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1199 messages_to_author = no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1200
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1201 # Where to place the email signature.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1202 # Allowed values: top, bottom, none
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1203 # Default: bottom
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1204 signature_position = bottom
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1205
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1206 # 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
1207 # 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
1208 # 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
1209 # 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
1210 # 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
1211 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1212 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1213 # Default: new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1214 add_author = new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1215
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1216 # 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
1217 # 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
1218 # 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
1219 # 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
1220 # 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
1221 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1222 # Allowed values: yes, no, new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1223 # Default: new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1224 add_recipients = new
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1225
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1226 # 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
1227 # "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
1228 # 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
1229 # each recipient as a CC address.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1230 # Default: single
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1231 email_sending = single
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1232
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1233 # 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
1234 # 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
1235 # 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
1236 # Default: 9223372036854775807
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1237 max_attachment_size = 9223372036854775807
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1238
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1239 .. index:: config.ini; sections markdown
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1240 .. _`config-ini-section-markdown`:
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1241 .. code:: ini
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1242
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1243
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1244 # Markdown rendering options.
8036
8b5f8b950f58 docs: add section anchors to config.ini in references.txt; change format
John Rouillard <rouilj@ieee.org>
parents: 7986
diff changeset
1245
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1246 [markdown]
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1247
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1248 # 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
1249 # 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
1250 # (GFM) handling of embedded newlines.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1251 # Allowed values: yes, no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1252 # Default: no
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1253 break_on_newline = no
Roundup Issue Tracker: http://roundup-tracker.org/