|
25 | 25 | "type": "string" |
26 | 26 | }, |
27 | 27 | "qwc_config_schema": { |
28 | | - "description": "The name of the DB schema which stores the qwc config. Default: qwc_config", |
| 28 | + "description": "The name of the DB schema which stores the qwc config. Default: `qwc_config`", |
29 | 29 | "type": "string" |
30 | 30 | }, |
31 | 31 | "password_min_length": { |
32 | | - "description": "Min password length", |
| 32 | + "description": "Min password length. Default: `8`", |
33 | 33 | "type": "integer" |
34 | 34 | }, |
35 | 35 | "password_max_length": { |
36 | | - "description": "Max password length", |
| 36 | + "description": "Max password length, or `-1` to disable. Default: `-1`", |
37 | 37 | "type": "integer" |
38 | 38 | }, |
39 | 39 | "password_constraints": { |
40 | | - "description": "List of RegExes for additional password constraints", |
| 40 | + "description": "List of RegExes for additional password constraints. Default: `[]`", |
41 | 41 | "type": "array", |
42 | 42 | "items": { |
43 | 43 | "type": "string" |
44 | 44 | } |
45 | 45 | }, |
46 | 46 | "password_min_constraints": { |
47 | | - "description": "Min number of password_constraints to match for password to be valid", |
| 47 | + "description": "Min number of password_constraints to match for password to be valid. Default: `0`", |
48 | 48 | "type": "integer" |
49 | 49 | }, |
50 | 50 | "password_constraints_message": { |
51 | | - "description": "Validation message if password constraints are not met", |
| 51 | + "description": "Validation message if password constraints are not met. Default: `Password does not match constraints`", |
52 | 52 | "type": "string" |
53 | 53 | }, |
54 | 54 | "password_expiry": { |
55 | | - "description": "Number of days until password expires, or -1 to disable", |
| 55 | + "description": "Number of days until password expires, or `-1` to disable. Default: `-1`", |
56 | 56 | "type": "integer" |
57 | 57 | }, |
58 | 58 | "password_expiry_notice": { |
59 | | - "description": "Show an expiry notice within this number of days before a password expires, or `-1` to disable", |
| 59 | + "description": "Show an expiry notice within this number of days before a password expires, or `-1` to disable. Default: `-1`", |
60 | 60 | "type": "integer" |
61 | 61 | }, |
62 | 62 | "password_update_interval": { |
63 | | - "description": "Min number of seconds before password may be changed again, or -1 to disable", |
| 63 | + "description": "Min number of seconds before password may be changed again, or -1 to disable. Default: `-1`", |
64 | 64 | "type": "integer" |
65 | 65 | }, |
66 | 66 | "password_allow_reuse": { |
67 | | - "description": "Set whether previous passwords may be reused or not", |
| 67 | + "description": "Set whether previous passwords may be reused or not. Default: `true`", |
68 | 68 | "type": "boolean" |
69 | 69 | }, |
70 | 70 | "user_info_fields": { |
71 | | - "description": "List of user info fields to include in JWT identity", |
| 71 | + "description": "List of user info fields to include in JWT identity. Default: `[]`", |
72 | 72 | "type": "array", |
73 | 73 | "items": { |
74 | 74 | "type": "string" |
75 | 75 | } |
76 | 76 | }, |
77 | 77 | "logo_image_url": { |
78 | | - "description": "URL to a logo image to show in the login form", |
| 78 | + "description": "URL to a logo image to show in the login form. Default: `null`", |
79 | 79 | "type": "string" |
80 | 80 | }, |
81 | 81 | "background_image_url": { |
82 | | - "description": "URL to a background image for the login page", |
| 82 | + "description": "URL to a background image for the login page. Default: `null`", |
83 | 83 | "type": "string" |
84 | 84 | }, |
85 | 85 | "customstylesheet": { |
86 | | - "description": "URL of custom stylesheet.", |
| 86 | + "description": "URL of custom stylesheet. Default: `null`", |
87 | 87 | "type": "string" |
88 | 88 | }, |
89 | 89 | "terms_url": { |
90 | | - "description": "URL to terms of use", |
| 90 | + "description": "URL to terms of use. Default: `null`", |
91 | 91 | "type": "string" |
92 | 92 | }, |
93 | 93 | "login_hint": { |
94 | | - "description": "Login hint text, shown above login form fields. Either a string, or dictionary `{\"<lang>\": \"<text>\"}`. When providing a dictionary, the entry matching the current locale will be searched, with fallback to `en` if no entry for the current locale exists, and fallback to an empty string if no `en` entry exists.", |
| 94 | + "description": "Login hint text, shown above login form fields. Either a string, or dictionary `{\"<lang>\": \"<text>\"}`. When providing a dictionary, the entry matching the current locale will be searched, with fallback to `en` if no entry for the current locale exists, and fallback to an empty string if no `en` entry exists. Default: `null`", |
95 | 95 | "oneOf":[ |
96 | 96 | {"type": "string"}, |
97 | 97 | { |
|
105 | 105 | ] |
106 | 106 | }, |
107 | 107 | "post_param_login": { |
108 | | - "description": "Whether 'username' and 'password', and possibly additional parameters, are passed as POST parameters. Additional parameters are appended to the target url query. Default: false", |
| 108 | + "description": "Whether 'username' and 'password', and possibly additional parameters, are passed as POST parameters. Additional parameters are appended to the target url query. Default: `false`", |
109 | 109 | "type": "boolean" |
110 | 110 | }, |
111 | 111 | "max_login_attempts": { |
112 | | - "description": "Maximum login attempts before login is blocked. Default: 20", |
| 112 | + "description": "Maximum login attempts before login is blocked. Default: `20`", |
113 | 113 | "type": "integer" |
114 | 114 | }, |
115 | 115 | "totp_enabled": { |
116 | | - "description": "Enable two factor authentication using TOTP. Default: false", |
| 116 | + "description": "Enable two factor authentication using TOTP. Default: `false`", |
117 | 117 | "type": "boolean" |
118 | 118 | }, |
119 | 119 | "totp_enabled_for_admin": { |
120 | | - "description": "Whether to enable two-factor authentication using TOTP for admin. Default: false", |
| 120 | + "description": "Whether to enable two-factor authentication using TOTP for admin. Default: `false`", |
121 | 121 | "type": "boolean" |
122 | 122 | }, |
123 | 123 | "totp_issuer_name": { |
124 | | - "description": "Issuer name for QR code URI. Default: 'QWC Services'", |
| 124 | + "description": "Issuer name for QR code URI. Default: `QWC Services`", |
125 | 125 | "type": "string" |
126 | 126 | }, |
127 | 127 | "ip_blacklist_duration": { |
128 | | - "description": "How many seconds an IP will remain in the blacklist. See also ip_blacklist_max_attempt_count. Default: 300", |
| 128 | + "description": "How many seconds an IP will remain in the blacklist. See also `ip_blacklist_max_attempt_count`. Default: `300`", |
129 | 129 | "type": "integer" |
130 | 130 | }, |
131 | 131 | "ip_blacklist_max_attempt_count": { |
132 | | - "description": "After how many failed login attempts an IP will be blacklisted. Should be less than max_login_attempts. See also ip_blacklist_duration. Default: 10", |
| 132 | + "description": "After how many failed login attempts an IP will be blacklisted. Should be less `than max_login_attempts`. See also `ip_blacklist_duration`. Default: `10`", |
133 | 133 | "type": "integer" |
134 | 134 | }, |
135 | 135 | "force_password_change_first_login": { |
|
0 commit comments