Mercurial Repository: p/roundup/code: doc/tracker

comparison doc/tracker_config.txt @ 8274:c3bf229d3d4b

doc: update tracker_config.txt Every generation of tracker_config.txt also changes the secret_key value. To prevent this from showing up in diffs, modify format_config.awk to use a static value for the secret_key and substitute it into the config file. Also update Makefile so tracker_config.txt depends on format_config.awk.

author	John Rouillard <rouilj@ieee.org>
date	Sun, 12 Jan 2025 20:13:36 -0500
parents	8b5f8b950f58
children	b99e76e76496

comparison

equal deleted inserted replaced

-:e7062c6efabf
+:c3bf229d3d4b
 # import.
 # Default: 131072
 csv_field_size = 131072
 # Sets the default number of rounds used when encoding passwords
-# using the PBKDF2 scheme. Set this to a higher value on faster
+# using any PBKDF2 scheme. Set this to a higher value on faster
-# systems which want more security.
+# systems which want more security. Use a minimum of 250000
+# for PBKDF2-SHA512 which is the default hash in Roundup 2.5.
 # PBKDF2 (Password-Based Key Derivation Function) is a
 # password hashing mechanism that derives hash from the
 # password and a random salt. For authentication this process
 # is repeated with the same salt as in the stored hash.
 # If both hashes match, the authentication succeeds.
 # of rounds doubles the cpu time required to calculate it. The
 # purpose of this is to periodically adjust the rounds as CPUs
 # become faster. The currently enforced minimum number of
 # rounds is 1000.
 # See: http://en.wikipedia.org/wiki/PBKDF2 and RFC2898
-# Default: 2000000
+# Default: 250000
-password_pbkdf2_default_rounds = 2000000
+password_pbkdf2_default_rounds = 250000
 .. index:: config.ini; sections tracker
 .. _`config-ini-section-tracker`:
 .. code:: ini
 # tracker.web setting in config.ini.
 # Set this to 'required' to block the post and notify
 #     the user if the header is missing or invalid.
 # Set this to 'yes' to block the post and notify the user
 #     if the header is invalid, but accept the form if
-#     the field is missing.
+#     the header is missing.
 # Set this to 'logfailure' to log a notice to the roundup
 #     log if the header is invalid or missing, but accept
 #     the post.
 # Set this to 'no' to ignore the header and accept the post.
 # Allowed values: required, yes, logfailure, no
 # tracker.web setting in config.ini.
 # Set this to 'required' to block the post and notify
 #     the user if the header is missing or invalid.
 # Set this to 'yes' to block the post and notify the user
 #     if the header is invalid, but accept the form if
-#     the field is missing.
+#     the header is missing.
 # Set this to 'logfailure' to log a notice to the roundup
 #     log if the header is invalid or missing, but accept
 #     the post.
 # Set this to 'no' to ignore the header and accept the post.
 # Allowed values: required, yes, logfailure, no
 # the host part of the tracker.web setting in config.ini.
 # Set this to 'required' to block the post and notify
 #     the user if the header is missing or invalid.
 # Set this to 'yes' to block the post and notify the user
 #     if the header is invalid, but accept the form if
-#     the field is missing.
+#     the header is missing.
 # Set this to 'logfailure' to log a notice to the roundup
 #     log if the header is invalid or missing, but accept
 #     the post.
 # Set this to 'no' to ignore the header and accept the post.
 # Allowed values: required, yes, logfailure, no
 # tracker.web setting in config.ini.
 # Set this to 'required' to block the post and notify
 #     the user if the header is missing or invalid.
 # Set this to 'yes' to block the post and notify the user
 #     if the header is invalid, but accept the form if
-#     the field is missing.
+#     the header is missing.
 # Set this to 'logfailure' to log a notice to the roundup
 #     log if the header is invalid or missing, but accept
 #     the post.
 # Set this to 'no' to ignore the header and accept the post.
 # Allowed values: required, yes, logfailure, no
 .. index:: config.ini; sections rdbms
 .. _`config-ini-section-rdbms`:
 .. code:: ini
-# Settings in this section (except for backend) are used
+# Most settings in this section (except for backend and debug_filter)
-#  by RDBMS backends only.
+# are used by RDBMS backends only.
 [rdbms]
 # Database backend.
 # Available backends: anydbm, mysql, sqlite, postgresql
 # Default: NO DEFAULT
 #backend = NO DEFAULT
+# Filter debugging: Permissions can define additional filter
+# functions that are used when checking permissions on results
+# returned by the database. This is done to improve
+# performance since the filtering is done in the database
+# backend, not in python (at least for the SQL backends). The
+# user is responsible for making the filter return the same
+# set of results as the check function for a permission. So it
+# makes sense to aid in debugging (and performance
+# measurements) to allow turning off the usage of filter
+# functions using only the check functions.
+# Allowed values: yes, no
+# Default: no
+debug_filter = no
 # Name of the database to use. For Postgresql, this can
 # be database.schema to use a specific schema within
 # a Postgres database.
 # Default: roundup

Mercurial > p > roundup > code

comparison doc/tracker_config.txt @ 8274:c3bf229d3d4b