Configuration Settings#
Core Configuration Settings#
Flag |
Description |
Default Value |
---|---|---|
|
A secret string value used to salt encryptions and hashes for the app. ABSOLUTELY MUST BE SET TO SOMETHING OTHER THAN DEFAULT IN PRODUCTION. |
DO NOT USE THE DEFAULT IN PRODUCTION |
|
The hash scheme used to hash passwords in the database. If unset,
passlib will use the default scheme which is |
|
|
A list of allowed algorithms that may be used to hash the JWT. See the PyJWT docs #algorithms for more details. |
|
|
The jwt hashing algorithm to be used to encode tokens |
|
|
The default length of time that a token may be used to access a protected endpoint. See the PyJWT docs #usage for more details. |
|
|
The default length of time that a token may be refreshed. Token may also not be refreshed if its access lifespan is not expired. |
|
|
A list of places where token will be checked |
|
|
The name of the cookie in HTTP requests where the token will be found |
|
|
The name of the header in HTTP requests where the token will be found |
|
|
A string describing the type of the header. Usually ‘Bearer’ but may be customized by the user |
|
|
The name of the method on a user instance that should be used to validate that the user is active in the system. |
|
|
Do not register the Sanic error handler automatically. The user may wish to configure the error handler themselves |
|
|
If set, role decorators will not work but rolenames will not be a required field |
|
|
If set, can be used either as the source of RBAC config, or as the initial value.
This will be overwritten if a {
'rolename_1': [
'access_right_1',
'access_right_2',
'access_right_3'
],
'rolename_2': [
'access_right_2',
'access_right_4'
],
'rolename_3': [
'access_right_5',
'access_right_6'
],
}
Note Either |
|
OTP Configuration Settings#
Flag |
Description |
Default Value |
---|---|---|
|
When supporting OTP, if a user is configured with TOTP information, should password authentication require TOTP validation before a successful response is provided, or leave it up to the application code to check and enforce. |
|
|
The type of secrets protection for the TOTP implementation. The available options are:
ABSOLUTELY MUST BE SET TO SOMETHING OTHER THAN DEFAULT IN PRODUCTION. |
DO NOT USE THE DEFAULT |
|
The string, wallet, or file path, as defined by the
If anything other than |
|
Mailer Configuration Settings#
Flag |
Description |
Default Value |
---|---|---|
|
Default From: address for password reset emails. |
|
|
Default Subject: line for password reset emails. |
|
|
A Jinja2 template to use for password reset emails. The default value is pointing to an included basic template file. |
|
|
Default From: address for new account confirmation emails. |
|
|
Default Subject: line for new account confirmation emails. |
|
|
A Jinja2 template to use for new account confirmation emails. The default value is pointing to an included basic template file. |
|