Mercurial > p > roundup > code

comparison doc/tracker_config.txt @ 8036:8b5f8b950f58

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: add section anchors to config.ini in references.txt; change format Added section anchors for each section of config.ini in the reference.html file. This makes it easier to link to the right section of the config file when discussing config.ini settings. Getting this to work using the initial sed implementation was going to be a nightmare, so rewrote it in awk. The pre-section comments are now separated by a blank line from the section marker. Also rst directives no longer have blank lines between them.
author John Rouillard <rouilj@ieee.org>
date Mon, 17 Jun 2024 22:58:18 -0400
parents 83a531e72e3e
children c3bf229d3d4b
comparison
equal deleted inserted replaced
8035:b516483f68a3 8036:8b5f8b950f58
1 1
2 .. index:: config.ini; sections main 2 .. index:: config.ini; sections main
3 3 .. _`config-ini-section-main`:
4 .. code:: ini 4 .. code:: ini
5 5
6 [main] 6 [main]
7 7
8 # Database directory path. 8 # Database directory path.
182 # See: http://en.wikipedia.org/wiki/PBKDF2 and RFC2898 182 # See: http://en.wikipedia.org/wiki/PBKDF2 and RFC2898
183 # Default: 2000000 183 # Default: 2000000
184 password_pbkdf2_default_rounds = 2000000 184 password_pbkdf2_default_rounds = 2000000
185 185
186 .. index:: config.ini; sections tracker 186 .. index:: config.ini; sections tracker
187 187 .. _`config-ini-section-tracker`:
188 .. code:: ini 188 .. code:: ini
189 189
190 [tracker] 190 [tracker]
191 191
192 # A descriptive name for your roundup instance. 192 # A descriptive name for your roundup instance.
229 # or LANG, in that order of preference. 229 # or LANG, in that order of preference.
230 # Default: 230 # Default:
231 language = 231 language =
232 232
233 .. index:: config.ini; sections web 233 .. index:: config.ini; sections web
234 234 .. _`config-ini-section-web`:
235 .. code:: ini 235 .. code:: ini
236 236
237 [web] 237 [web]
238 238
239 # Setting this option enables Roundup to serve uploaded HTML 239 # Setting this option enables Roundup to serve uploaded HTML
593 # line of the file will be used as the value. Any 593 # line of the file will be used as the value. Any
594 # string that does not start with 'file://' is used 594 # string that does not start with 'file://' is used
595 # as is. It removes any whitespace at the end of the 595 # as is. It removes any whitespace at the end of the
596 # line, so a newline can be put in the file. 596 # line, so a newline can be put in the file.
597 # 597 #
598 # Default: 3CpCdT9GrdQv7SCn24DTIQTwAoBguqhAopZnXRZA38w= 598 # Default: DWmbKgVUy6fF5D2Y5TD5Az+dnHhMYKCCpJzIY3H8nsU=
599 secret_key = 3CpCdT9GrdQv7SCn24DTIQTwAoBguqhAopZnXRZA38w= 599 secret_key = DWmbKgVUy6fF5D2Y5TD5Az+dnHhMYKCCpJzIY3H8nsU=
600 600
601 # This is used to sign/validate json web tokens 601 # This is used to sign/validate json web tokens
602 # (JWT). Even if you don't use JWTs it must not be 602 # (JWT). Even if you don't use JWTs it must not be
603 # empty. You can use multiple secrets separated by a 603 # empty. You can use multiple secrets separated by a
604 # comma ','. This allows for secret rotation. The newest 604 # comma ','. This allows for secret rotation. The newest
622 # 622 #
623 # Default: disabled 623 # Default: disabled
624 jwt_secret = disabled 624 jwt_secret = disabled
625 625
626 .. index:: config.ini; sections rdbms 626 .. index:: config.ini; sections rdbms
627 627 .. _`config-ini-section-rdbms`:
628 .. code:: ini 628 .. code:: ini
629 629
630
630 # Settings in this section (except for backend) are used 631 # Settings in this section (except for backend) are used
631 # by RDBMS backends only. 632 # by RDBMS backends only.
633
632 [rdbms] 634 [rdbms]
633 635
634 # Database backend. 636 # Database backend.
635 # Available backends: anydbm, mysql, sqlite, postgresql 637 # Available backends: anydbm, mysql, sqlite, postgresql
636 # Default: NO DEFAULT 638 # Default: NO DEFAULT
765 # Allowed values: yes, no 767 # Allowed values: yes, no
766 # Default: yes 768 # Default: yes
767 serverside_cursor = yes 769 serverside_cursor = yes
768 770
769 .. index:: config.ini; sections sessiondb 771 .. index:: config.ini; sections sessiondb
770 772 .. _`config-ini-section-sessiondb`:
771 .. code:: ini 773 .. code:: ini
772 774
775
773 # Choose configuration for session and one time key storage. 776 # Choose configuration for session and one time key storage.
777
774 [sessiondb] 778 [sessiondb]
775 779
776 # Set backend for storing one time key (otk) and session data. 780 # Set backend for storing one time key (otk) and session data.
777 # Values have to be compatible with main backend. 781 # Values have to be compatible with main backend.
778 # main\/ session>| anydbm | sqlite | redis | mysql | postgresql | 782 # main\/ session>| anydbm | sqlite | redis | mysql | postgresql |
798 # 802 #
799 # Default: redis://localhost:6379/0?health_check_interval=2 803 # Default: redis://localhost:6379/0?health_check_interval=2
800 redis_url = redis://localhost:6379/0?health_check_interval=2 804 redis_url = redis://localhost:6379/0?health_check_interval=2
801 805
802 .. index:: config.ini; sections logging 806 .. index:: config.ini; sections logging
803 807 .. _`config-ini-section-logging`:
804 .. code:: ini 808 .. code:: ini
805 809
806 [logging] 810 [logging]
807 811
808 # Path to configuration file for standard Python logging module. 812 # Path to configuration file for standard Python logging module.
834 # Allowed values: yes, no 838 # Allowed values: yes, no
835 # Default: no 839 # Default: no
836 disable_loggers = no 840 disable_loggers = no
837 841
838 .. index:: config.ini; sections mail 842 .. index:: config.ini; sections mail
839 843 .. _`config-ini-section-mail`:
840 .. code:: ini 844 .. code:: ini
841 845
846
842 # Outgoing email options. 847 # Outgoing email options.
843 # Used for nosy messages, password reset and registration approval 848 # Used for nosy messages, password reset and registration approval
844 # requests. 849 # requests.
850
845 [mail] 851 [mail]
846 852
847 # The email domain that admin_email, issue_tracker and 853 # The email domain that admin_email, issue_tracker and
848 # dispatcher_email belong to. 854 # dispatcher_email belong to.
849 # This domain is added to those config items if they don't 855 # This domain is added to those config items if they don't
940 # Allowed values: yes, no 946 # Allowed values: yes, no
941 # Default: yes 947 # Default: yes
942 add_authoremail = yes 948 add_authoremail = yes
943 949
944 .. index:: config.ini; sections mailgw 950 .. index:: config.ini; sections mailgw
945 951 .. _`config-ini-section-mailgw`:
946 .. code:: ini 952 .. code:: ini
947 953
954
948 # Roundup Mail Gateway options 955 # Roundup Mail Gateway options
956
949 [mailgw] 957 [mailgw]
950 958
951 # Keep email citations when accepting messages. 959 # Keep email citations when accepting messages.
952 # Setting this to "no" strips out "quoted" text 960 # Setting this to "no" strips out "quoted" text
953 # from the message. Setting this to "new" keeps quoted 961 # from the message. Setting this to "new" keeps quoted
1085 # Allowed values: yes, no 1093 # Allowed values: yes, no
1086 # Default: no 1094 # Default: no
1087 keep_real_from = no 1095 keep_real_from = no
1088 1096
1089 .. index:: config.ini; sections pgp 1097 .. index:: config.ini; sections pgp
1090 1098 .. _`config-ini-section-pgp`:
1091 .. code:: ini 1099 .. code:: ini
1092 1100
1101
1093 # OpenPGP mail processing options 1102 # OpenPGP mail processing options
1103
1094 [pgp] 1104 [pgp]
1095 1105
1096 # Enable PGP processing. Requires gpg. If you're planning 1106 # Enable PGP processing. Requires gpg. If you're planning
1097 # to send encrypted PGP mail to the tracker, you should also 1107 # to send encrypted PGP mail to the tracker, you should also
1098 # enable the encrypt-option below, otherwise mail received 1108 # enable the encrypt-option below, otherwise mail received
1135 # turned on. 1145 # turned on.
1136 # Default: signed 1146 # Default: signed
1137 require_incoming = signed 1147 require_incoming = signed
1138 1148
1139 .. index:: config.ini; sections nosy 1149 .. index:: config.ini; sections nosy
1140 1150 .. _`config-ini-section-nosy`:
1141 .. code:: ini 1151 .. code:: ini
1142 1152
1153
1143 # Nosy messages sending 1154 # Nosy messages sending
1155
1144 [nosy] 1156 [nosy]
1145 1157
1146 # Send nosy messages to the author of the message. 1158 # Send nosy messages to the author of the message.
1147 # Allowed values: yes, no, new, nosy -- if yes, messages 1159 # Allowed values: yes, no, new, nosy -- if yes, messages
1148 # are sent to the author even if not on the nosy list, same 1160 # are sent to the author even if not on the nosy list, same
1188 # a link to the tracker's download page for the file. 1200 # a link to the tracker's download page for the file.
1189 # Default: 9223372036854775807 1201 # Default: 9223372036854775807
1190 max_attachment_size = 9223372036854775807 1202 max_attachment_size = 9223372036854775807
1191 1203
1192 .. index:: config.ini; sections markdown 1204 .. index:: config.ini; sections markdown
1193 1205 .. _`config-ini-section-markdown`:
1194 .. code:: ini 1206 .. code:: ini
1195 1207
1208
1196 # Markdown rendering options. 1209 # Markdown rendering options.
1210
1197 [markdown] 1211 [markdown]
1198 1212
1199 # If yes/true, render single new line characters in markdown 1213 # If yes/true, render single new line characters in markdown
1200 # text with <br>. Set true if you want GitHub Flavored Markdown 1214 # text with <br>. Set true if you want GitHub Flavored Markdown
1201 # (GFM) handling of embedded newlines. 1215 # (GFM) handling of embedded newlines.
Roundup Issue Tracker: http://roundup-tracker.org/