Rev 1169 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
261 | daniel-mar | 1 | |
2 | OVERVIEW OF ALL CONFIG.INC.PHP SETTINGS |
||
3 | ======================================= |
||
4 | |||
294 | daniel-mar | 5 | The file userdata/baseconfig/config.inc.php contains various settings |
261 | daniel-mar | 6 | which are essential to connect to your database and other |
7 | things that should be known before the database connection |
||
8 | is opened. |
||
294 | daniel-mar | 9 | Other settings are stored in the database (table "config") |
261 | daniel-mar | 10 | and can be accessed using the admin login area. |
11 | |||
294 | daniel-mar | 12 | The setup assistant (/setup/) will lead you through |
13 | the creation of the most important settings of config.inc.php. |
||
261 | daniel-mar | 14 | |
294 | daniel-mar | 15 | Below you will find a list of all possible config settings |
16 | of the default OIDplus installation/plugins. |
||
17 | Please note that a plugin can define any key. |
||
18 | |||
19 | |||
261 | daniel-mar | 20 | ------------------------------------- |
21 | (1) CONFIG SETTINGS PROVIDED BY SETUP |
||
22 | ------------------------------------- |
||
23 | |||
24 | OIDplus::baseConfig()->setValue('CONFIG_VERSION', 2.1); |
||
25 | |||
471 | daniel-mar | 26 | OIDplus::baseConfig()->setValue('ADMIN_PASSWORD', '<BCrypt hash, or base64 encoded SHA3-512 hash>'); |
609 | daniel-mar | 27 | If you want to have multiple valid administrator passwords |
28 | (e.g. if you want multiple users), then this value can |
||
29 | also be an array containing hashes. |
||
261 | daniel-mar | 30 | |
31 | OIDplus::baseConfig()->setValue('DATABASE_PLUGIN', ''); |
||
786 | daniel-mar | 32 | Valid values: see plugins (setup/) |
261 | daniel-mar | 33 | |
786 | daniel-mar | 34 | OIDplus::baseConfig()->setValue('OCI_CONN_STR', 'localhost/orcl'); |
35 | Can be a Oracle connection string/TNS or a hostname like |
||
36 | |||
37 | OIDplus::baseConfig()->setValue('OCI_USERNAME', 'hr'); |
||
38 | |||
39 | OIDplus::baseConfig()->setValue('OCI_PASSWORD', 'oracle'); |
||
40 | |||
261 | daniel-mar | 41 | OIDplus::baseConfig()->setValue('ODBC_DSN', 'DRIVER={SQL Server};SERVER=localhost;DATABASE=oidplus;CHARSET=UTF8'); |
42 | |||
43 | OIDplus::baseConfig()->setValue('ODBC_USERNAME', 'sa'); |
||
44 | |||
45 | OIDplus::baseConfig()->setValue('ODBC_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
844 | daniel-mar | 46 | The base64 encoding protects your password from being read if someone |
47 | "looks over your shoulder" at your display while you have the configuration file opened. |
||
48 | (Obviously, it doesn't protect you if they can make a photo or screenshot) |
||
261 | daniel-mar | 49 | |
50 | OIDplus::baseConfig()->setValue('PDO_DSN', 'pgsql:host=localhost;dbname=oidplus'); |
||
51 | |||
52 | OIDplus::baseConfig()->setValue('PDO_USERNAME', 'postgres'); |
||
53 | |||
54 | OIDplus::baseConfig()->setValue('PDO_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
844 | daniel-mar | 55 | The base64 encoding protects your password from being read if someone |
56 | "looks over your shoulder" at your display while you have the configuration file opened. |
||
57 | (Obviously, it doesn't protect you if they can make a photo or screenshot) |
||
261 | daniel-mar | 58 | |
59 | OIDplus::baseConfig()->setValue('MYSQL_HOST', 'localhost:3306'); |
||
814 | daniel-mar | 60 | The hostname to connect to. Port (:3306) is optional. |
261 | daniel-mar | 61 | |
813 | daniel-mar | 62 | OIDplus::baseConfig()->setValue('MYSQL_SOCKET', ''); |
63 | In case you connect via MySQL through a socket, use this setting. |
||
64 | (It is currently not included in setup/ and needs to be set manually). |
||
65 | |||
261 | daniel-mar | 66 | OIDplus::baseConfig()->setValue('MYSQL_USERNAME', 'root'); |
67 | |||
68 | OIDplus::baseConfig()->setValue('MYSQL_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
844 | daniel-mar | 69 | The base64 encoding protects your password from being read if someone |
70 | "looks over your shoulder" at your display while you have the configuration file opened. |
||
71 | (Obviously, it doesn't protect you if they can make a photo or screenshot) |
||
261 | daniel-mar | 72 | |
73 | OIDplus::baseConfig()->setValue('MYSQL_DATABASE', 'oidplus'); |
||
74 | |||
75 | OIDplus::baseConfig()->setValue('PGSQL_HOST', 'localhost:5432'); |
||
814 | daniel-mar | 76 | The hostname to connect to. Port (:5432) is optional. |
261 | daniel-mar | 77 | |
814 | daniel-mar | 78 | OIDplus::baseConfig()->setValue('PGSQL_SOCKET', ''); |
79 | In case you connect via PostgreSQL through a socket, use this setting. |
||
80 | (It is currently not included in setup/ and needs to be set manually). |
||
81 | |||
261 | daniel-mar | 82 | OIDplus::baseConfig()->setValue('PGSQL_USERNAME', 'postgres'); |
83 | |||
84 | OIDplus::baseConfig()->setValue('PGSQL_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
844 | daniel-mar | 85 | The base64 encoding protects your password from being read if someone |
86 | "looks over your shoulder" at your display while you have the configuration file opened. |
||
87 | (Obviously, it doesn't protect you if they can make a photo or screenshot) |
||
261 | daniel-mar | 88 | |
89 | OIDplus::baseConfig()->setValue('PGSQL_DATABASE', 'oidplus'); |
||
90 | |||
264 | daniel-mar | 91 | |
713 | daniel-mar | 92 | OIDplus::baseConfig()->setValue('SQLITE3_FILE', 'userdata/database/oidplus.db'); |
93 | Attention: This file must be located in a location that is not world-readable/downloadable! |
||
264 | daniel-mar | 94 | |
713 | daniel-mar | 95 | OIDplus::baseConfig()->setValue('SQLITE3_ENCRYPTION', ''); |
96 | Optional encryption |
||
264 | daniel-mar | 97 | |
261 | daniel-mar | 98 | OIDplus::baseConfig()->setValue('TABLENAME_PREFIX', 'oidplus_'); |
99 | |||
100 | OIDplus::baseConfig()->setValue('SERVER_SECRET', 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); |
||
713 | daniel-mar | 101 | It is very very important that you choose a long sequence of |
261 | daniel-mar | 102 | random characters. OIDplus uses this secret for various |
103 | security related purposes. If someone accidently received this secret, |
||
104 | please change the sequence. |
||
105 | |||
713 | daniel-mar | 106 | OIDplus::baseConfig()->setValue('CAPTCHA_PLUGIN', 'None'); |
1027 | daniel-mar | 107 | Alternative Values (installed plugins) |
108 | - reCAPTCHA |
||
109 | - hCaptcha |
||
110 | - ViaThinkSoft Client Challenge |
||
713 | daniel-mar | 111 | |
1050 | daniel-mar | 112 | OIDplus::baseConfig()->setValue('RECAPTCHA_VERSION', \ViaThinkSoft\OIDplus\OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V2_CHECKBOX); |
1016 | daniel-mar | 113 | Possible values: |
1050 | daniel-mar | 114 | \ViaThinkSoft\OIDplus\OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V2_CHECKBOX |
115 | \ViaThinkSoft\OIDplus\OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V2_INVISIBLE |
||
116 | \ViaThinkSoft\OIDplus\OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V3 |
||
1016 | daniel-mar | 117 | |
261 | daniel-mar | 118 | OIDplus::baseConfig()->setValue('RECAPTCHA_ENABLED', true); |
702 | daniel-mar | 119 | Deprecated! |
1027 | daniel-mar | 120 | RECAPTCHA_ENABLED=true becomes CAPTCHA_PLUGIN=reCAPTCHA |
702 | daniel-mar | 121 | RECAPTCHA_ENABLED=false becomes CAPTCHA_PLUGIN=None |
261 | daniel-mar | 122 | |
123 | OIDplus::baseConfig()->setValue('RECAPTCHA_PUBLIC', ''); |
||
713 | daniel-mar | 124 | Only used if CAPTCHA_PLUGIN=ReCAPTCHA |
261 | daniel-mar | 125 | |
126 | OIDplus::baseConfig()->setValue('RECAPTCHA_PRIVATE', ''); |
||
713 | daniel-mar | 127 | Only used if CAPTCHA_PLUGIN=ReCAPTCHA |
261 | daniel-mar | 128 | |
1001 | daniel-mar | 129 | OIDplus::baseConfig()->setValue('HCAPTCHA_SITEKEY', ''); |
130 | Only used if CAPTCHA_PLUGIN=hCaptcha |
||
131 | |||
132 | OIDplus::baseConfig()->setValue('HCAPTCHA_SECRET', ''); |
||
133 | Only used if CAPTCHA_PLUGIN=hCaptcha |
||
134 | |||
974 | daniel-mar | 135 | OIDplus::baseConfig()->setValue('ENFORCE_SSL', OIDplus::ENFORCE_SSL_AUTO); |
136 | Values OIDplus::ENFORCE_SSL_NO (0) = (off) |
||
137 | OIDplus::ENFORCE_SSL_YES (1) = (on) |
||
138 | OIDplus::ENFORCE_SSL_AUTO (2) = (auto detect SSL) |
||
261 | daniel-mar | 139 | |
1036 | daniel-mar | 140 | OIDplus::baseConfig()->setValue('VTS_CAPTCHA_COMPLEXITY', 50000); |
141 | Only used if CAPTCHA_PLUGIN=ViaThinkSoft Client Challenge |
||
261 | daniel-mar | 142 | |
1036 | daniel-mar | 143 | OIDplus::baseConfig()->setValue('VTS_CAPTCHA_AUTOSOLVE', true); |
144 | Only used if CAPTCHA_PLUGIN=ViaThinkSoft Client Challenge |
||
145 | |||
146 | OIDplus::baseConfig()->setValue('VTS_CAPTCHA_MAXTIME', 10*60/*10 minutes*/); |
||
147 | Only used if CAPTCHA_PLUGIN=ViaThinkSoft Client Challenge |
||
148 | |||
261 | daniel-mar | 149 | ---------------------- |
374 | daniel-mar | 150 | (2) SYSTEM LIMITATIONS (defined and documented in includes/oidplus_limits.inc.php , can be overwritten by config.inc.php) |
261 | daniel-mar | 151 | ---------------------- |
152 | |||
153 | OIDplus::baseConfig()->setValue('LIMITS_MAX_ID_LENGTH', 255); |
||
713 | daniel-mar | 154 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 155 | |
156 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_ASN1_ID_LEN', 255); |
||
713 | daniel-mar | 157 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 158 | |
159 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_UNICODE_LABEL_LEN', 255); |
||
713 | daniel-mar | 160 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 161 | |
162 | |||
163 | ----------------------------------------- |
||
164 | (3) "HIDDEN"/UNDOCUMENTED CONFIG SETTINGS |
||
165 | ----------------------------------------- |
||
166 | |||
1182 | daniel-mar | 167 | OIDplus::baseConfig()->setValue('OFFLINE_MODE', false); |
168 | If set to true, OIDplus will not contact other servers. No system registration, |
||
169 | no hCaptcha, no reCAPTCHA, no system updates, etc. |
||
170 | |||
261 | daniel-mar | 171 | OIDplus::baseConfig()->setValue('OIDINFO_API_URL', '<url>'); |
713 | daniel-mar | 172 | Currently only internal use for development utilities (dev/). |
502 | daniel-mar | 173 | The API to oid-info.com is currently not public. |
261 | daniel-mar | 174 | |
175 | OIDplus::baseConfig()->setValue('REGISTRATION_HIDE_SYSTEM', true); |
||
713 | daniel-mar | 176 | Set this if you have a clone of a productive system and you want |
261 | daniel-mar | 177 | to avoid that the clone registers at the ViaThinkSoft directory |
178 | (which would overwrite the URL of the productive system and reveal |
||
179 | the URL of your testing system) |
||
180 | |||
181 | OIDplus::baseConfig()->setValue('MYSQL_FORCE_MYSQLND_SUPPLEMENT', false); |
||
713 | daniel-mar | 182 | The MySQLi plugin contains a supplement code to handle |
261 | daniel-mar | 183 | prepared statements on servers which do not have the MySQLnd extension |
184 | installed. Set this flag to force the supplement to be used, |
||
185 | even if MySQLnd is available. (For testing purposes only) |
||
186 | |||
187 | OIDplus::baseConfig()->setValue('QUERY_LOGFILE', ''); |
||
713 | daniel-mar | 188 | Set this setting to a filename where all queries including timestamps would be written. |
261 | daniel-mar | 189 | This is used for performance analysis. |
190 | Please choose a directory that cannot be accessed by world-wide. |
||
191 | |||
192 | OIDplus::baseConfig()->setValue('SESSION_LIFETIME', 30*60); |
||
713 | daniel-mar | 193 | Session lifetime in seconds. |
261 | daniel-mar | 194 | |
195 | OIDplus::baseConfig()->setValue('OBJECT_CACHING', true); |
||
196 | |||
197 | OIDplus::baseConfig()->setValue('FORCE_DBMS_SLANG', ''); |
||
1036 | daniel-mar | 198 | Currently valid values: access, mssql, mysql, oracle, pgsql, sqlite |
261 | daniel-mar | 199 | |
502 | daniel-mar | 200 | OIDplus::baseConfig()->setValue('PREPARED_STATEMENTS_EMULATION', 'auto'); |
713 | daniel-mar | 201 | Currently only for ODBC database plugin. |
502 | daniel-mar | 202 | 'auto' = Auto detect if prepared statements should be emulated |
203 | 'on' = Always emulate prepared statements |
||
204 | 'off' = Never emulate prepared statements |
||
205 | |||
261 | daniel-mar | 206 | OIDplus::baseConfig()->setValue('MINIFY_CSS', true); |
417 | daniel-mar | 207 | This enables the compression of CSS definitions. |
208 | Compressed approx: 220 KB |
||
209 | Uncompressed approx: 224 KB |
||
261 | daniel-mar | 210 | |
211 | OIDplus::baseConfig()->setValue('MINIFY_JS', true); |
||
417 | daniel-mar | 212 | This enables the compression of JavaScript code. |
213 | Please only disable this, if you want to debug |
||
214 | the code! You should not disable it on a productive |
||
215 | system, because otherwise the JavaScript code |
||
216 | would be several Megabytes large. |
||
217 | Compressed approx: 1133 KB |
||
218 | Unompressed approx: 2761 KB |
||
261 | daniel-mar | 219 | |
297 | daniel-mar | 220 | OIDplus::baseConfig()->setValue('DISABLE_PLUGIN_...', true); |
713 | daniel-mar | 221 | This gives you the possibility to disable a plugin without |
297 | daniel-mar | 222 | requiring it to be removed from the file system. |
223 | (Removing a plugin from the file system can result in various |
||
224 | problems, e.g. they can be re-added during a SVN/software update.) |
||
1050 | daniel-mar | 225 | Replace "..." with the main PHP class of the plugin you want to disable. |
226 | The namespace must be included. |
||
297 | daniel-mar | 227 | Example: |
1050 | daniel-mar | 228 | "DISABLE_PLUGIN_ViaThinkSoft\OIDplus\OIDplusLoggerPluginUserdataLogfile" |
297 | daniel-mar | 229 | disables the plugin "logger/300_userdata_logfile". |
316 | daniel-mar | 230 | |
231 | OIDplus::baseConfig()->setValue('DISABLE_AJAX_TRANSACTIONS', false); |
||
232 | This will disable the usage of database transactions in ajax.php |
||
233 | Do only use this if you have severe problems with the system running. |
||
234 | It might result in inconsistent data e.g. if you update an OID |
||
235 | and an error occurs in the middle of that process. |
||
326 | daniel-mar | 236 | |
806 | daniel-mar | 237 | OIDplus::baseConfig()->setValue('CANONICAL_SYSTEM_URL', ''); |
238 | Setting this value to a system URL will override the absolute system URL detection. |
||
239 | It has the following effects: |
||
240 | 1. The "canonical" metatag will use this explicit system URL |
||
241 | instead of the one the PHP script is detecting. |
||
242 | (This is important to avoid duplicate content at search indexes) |
||
243 | 2. CLI WHOIS and other CLI (Command-line-interface) tools |
||
244 | will use this address when they need to output an URL. |
||
245 | Otherwise, the CLI tools would need to use the last known |
||
246 | URL that was detected when a webpage visitor has last visited the |
||
247 | page. |
||
248 | 3. While most resources (images, CSS files, scripts, etc.) are loaded |
||
249 | via relative URLs, sometimes an absolute URL is required |
||
250 | (e.g., if an email is sent with an activation link). |
||
251 | The explicit absolute system URL will then be used rather |
||
252 | than the automatically detected one. |
||
253 | Note that setting an absolute system URL can be very useful if |
||
254 | OIDplus runs on a system (which detects itself as "X"), |
||
807 | daniel-mar | 255 | while the canonical URL "Y" is a reverse-proxy. |
778 | daniel-mar | 256 | |
456 | daniel-mar | 257 | OIDplus::baseConfig()->setValue('DEBUG', false); |
258 | Enables some special checks for plugins (e.g. a self-test for auth plugins). |
||
259 | It is highly recommended that you enable DEBUG if you are developing |
||
260 | plugins! |
||
470 | daniel-mar | 261 | It is recommended to disable this switch in productive systems, |
262 | because the self-tests decrease the performance. |
||
263 | However, after installing a new plugin, you might want to enable |
||
264 | it for a few minutes, to make sure the plugin is working correctly. |
||
430 | daniel-mar | 265 | |
557 | daniel-mar | 266 | OIDplus::baseConfig()->setValue('COOKIE_SAMESITE_POLICY', 'Strict'); |
267 | Defined which "SameSite" policy should be used for the cookies OIDplus uses. |
||
268 | Can be "None", "Lax" or "Strict". |
||
269 | "Strict" is the most secure setting. |
||
270 | "Lax" allows that people stay logged in if they follow a link pointing |
||
271 | to your OIDplus installation. |
||
272 | "None" is not recommended and is deprecated by modern web browsers. |
||
273 | However, OIDplus itself provides an Anti-CSRF mechanism, so you should be |
||
274 | still safe. |
||
456 | daniel-mar | 275 | |
812 | daniel-mar | 276 | OIDplus::baseConfig()->setValue('COOKIE_DOMAIN', ''); |
277 | Can be used to increase security by setting an explicit domain-name in the cookies. |
||
278 | Set to '' (empty string) to allow all (sub)domains. |
||
279 | Set to '(auto)' to automatically detect the domain based on the absolute canonical path. |
||
280 | |||
281 | OIDplus::baseConfig()->setValue('COOKIE_PATH', '/'); |
||
282 | Can be used to increase security by setting an explicit pathname in the cookies. |
||
283 | Set to '/' to allow all paths. |
||
284 | Set to '(auto)' to automatically detect the path based on the absolute canonical path. |
||
285 | Note: If supported, you can use Apache's "ProxyPassReverseCookiePath" to translate |
||
286 | the cookie path in a reverse-proxy setting. |
||
287 | |||
713 | daniel-mar | 288 | OIDplus::baseConfig()->getValue('RA_PASSWORD_PEPPER', ''); |
617 | daniel-mar | 289 | The pepper is stored inside the base configuration file |
290 | It prevents that an attacker with SQL write rights can |
||
291 | create accounts. |
||
292 | ATTENTION!!! If a pepper is used, then the |
||
293 | hashes are bound to that pepper. If you change the pepper, |
||
294 | then ALL passwords of RAs become INVALID! |
||
557 | daniel-mar | 295 | |
713 | daniel-mar | 296 | OIDplus::baseConfig()->getValue('RA_PASSWORD_PEPPER_ALGO', 'sha512'); |
711 | daniel-mar | 297 | The pepper is stored inside the base configuration file |
298 | It prevents that an attacker with SQL write rights can |
||
299 | create accounts. |
||
300 | ATTENTION!!! If a pepper is used, then the |
||
301 | hashes are bound to that pepper. If you change the pepper, |
||
302 | then ALL passwords of RAs become INVALID! |
||
617 | daniel-mar | 303 | |
1041 | daniel-mar | 304 | OIDplus::baseConfig()->setValue('DEFAULT_LANGUAGE', 'enus'); |
305 | Default language of the system. This is the language |
||
306 | a new visitor will see if no "lang=" parameter is used |
||
307 | and no cookie is set. |
||
308 | Must be a valid language in the plugins directory. |
||
309 | Currently available: |
||
310 | enus = English USA (default) |
||
311 | dede = German Germany |
||
711 | daniel-mar | 312 | |
430 | daniel-mar | 313 | ---------------------------------------------------- |
314 | (4) LDAP FIELDS (see document ldap_installation.txt) |
||
315 | ---------------------------------------------------- |
||
316 | |||
620 | daniel-mar | 317 | OIDplus::baseConfig()->setValue('LDAP_ENABLED', true); |
318 | Set to true if you want to enable that users can log-in using LDAP / ActiveDirectory. |
||
432 | daniel-mar | 319 | |
625 | daniel-mar | 320 | OIDplus::baseConfig()->setValue('LDAP_NUM_DOMAINS', 1); |
321 | Contains the number of domains/servers which are used. |
||
322 | For 2nd, 3rd, 4th, ... domain use the fields LDAP_xxx__2, LDAP_xxx__3, ... |
||
323 | e.g. LDAP_SERVER__2 |
||
324 | LDAP_PORT__2 |
||
325 | LDAP_BASE_DN__2 |
||
326 | ... |
||
327 | |||
620 | daniel-mar | 328 | OIDplus::baseConfig()->setValue('LDAP_SERVER', 'ldap://server1.contoso.local'); |
329 | The LDAP server of your company. |
||
432 | daniel-mar | 330 | |
620 | daniel-mar | 331 | OIDplus::baseConfig()->setValue('LDAP_PORT', 389); |
332 | The port of the LDAP server |
||
333 | |||
334 | OIDplus::baseConfig()->setValue('LDAP_BASE_DN', 'DC=CONTOSO,DC=local'); |
||
335 | The base Distinguished Name (DN) of your directory. |
||
336 | |||
625 | daniel-mar | 337 | OIDplus::baseConfig()->setValue('LDAP_UPN_SUFFIX', '@contoso.local'); |
338 | The UPN suffix of this domain. |
||
339 | |||
340 | OIDplus::baseConfig()->setValue('LDAP_AUTHENTICATE_UPN', true); |
||
620 | daniel-mar | 341 | In the login mask, the users will log in using the UPN ("principal name") e.g. username@contoso.local, |
342 | and in OIDplus, a RA account with an email equal to the UPN will be created. |
||
343 | |||
344 | OIDplus::baseConfig()->setValue('LDAP_AUTHENTICATE_EMAIL', false); |
||
345 | In the login mask, the users will log in using the UPN ("principal name") e.g. username@contoso.local, |
||
346 | and in OIDplus, a RA account with an email equal to the "E-Mail-Address" field of the user in the directory will be created. |
||
347 | Note: If you did not set an email address to the user in the LDAP/ActiveDirectory, then the login will not be possible, |
||
348 | except if LDAP_AUTHENTICATE_UPN is additionally enabled. |
||
349 | Attention: Depending on your domain configuration, users might be able to change their own data, |
||
350 | e.g. email address. If this is the case, you must not enable this setting, otherwise, |
||
351 | users could authenticate with any address! |
||
352 | |||
623 | daniel-mar | 353 | OIDplus::baseConfig()->setValue('LDAP_ADMIN_GROUP', ''); |
354 | If set to an empty string, the OIDplus administrator account cannot be accessed using LDAP authentication. |
||
355 | Otherwise, the user will be authenticated as administrator, if the LDAP user is a |
||
624 | daniel-mar | 356 | member of the group specified in this setting. |
623 | daniel-mar | 357 | Example values: CN=Administrators,CN=Builtin,DC=CONTOSO,DC=local |
358 | makes every domain administrator also an OIDplus administrator |
||
359 | CN=OIDplus Administrators,CN=Users,DC=CONTOSO,DC=local |
||
360 | makes every user of the group (OIDplus Administrators) to OIDplus administrators |
||
361 | |||
362 | OIDplus::baseConfig()->setValue('LDAP_RA_GROUP', ''); |
||
363 | If set to an empty string, every LDAP user can authenticate as RA, depending |
||
364 | on whether LDAP_AUTHENTICATE_UPN and/or LDAP_AUTHENTICATE_EMAIL is set. |
||
624 | daniel-mar | 365 | Otherwise, the LDAP users must be a member of the group specified in this setting. |
620 | daniel-mar | 366 | |
367 | |||
432 | daniel-mar | 368 | ---------------------------------------------------------------------- |
369 | (5) GOOGLE OAUTH2 FIELDS (see document google_oauth2_installation.txt) |
||
370 | ---------------------------------------------------------------------- |
||
371 | |||
372 | OIDplus::baseConfig()->setValue('GOOGLE_OAUTH2_ENABLED', true); |
||
373 | OIDplus::baseConfig()->setValue('GOOGLE_OAUTH2_CLIENT_ID', '..............apps.googleusercontent.com'); |
||
374 | OIDplus::baseConfig()->setValue('GOOGLE_OAUTH2_CLIENT_SECRET', '.............'); |
||
436 | daniel-mar | 375 | |
376 | |||
1036 | daniel-mar | 377 | -------------------------------------------------------------------------- |
436 | daniel-mar | 378 | (6) FACEBOOK OAUTH2 FIELDS (see document facebook_oauth2_installation.txt) |
1036 | daniel-mar | 379 | -------------------------------------------------------------------------- |
436 | daniel-mar | 380 | |
381 | OIDplus::baseConfig()->setValue('FACEBOOK_OAUTH2_ENABLED', true); |
||
382 | OIDplus::baseConfig()->setValue('FACEBOOK_OAUTH2_CLIENT_ID', '.............'); // Your App ID |
||
383 | OIDplus::baseConfig()->setValue('FACEBOOK_OAUTH2_CLIENT_SECRET', '.............'); // Your App Secret |
||
572 | daniel-mar | 384 | |
385 | |||
386 | ---------------------------------------------------- |
||
387 | (7) JWT AUTHENTICATION FIELDS |
||
388 | ---------------------------------------------------- |
||
389 | |||
390 | If a web request contains the field "OIDPLUS_AUTH_JWT" containing a signed JWT token, |
||
391 | an automatic one-time login is performed in order to execute commands. |
||
392 | This feature is used in the plugins "Automated AJAX calls" for admins and RAs. |
||
393 | With these switches you can disable this feature. |
||
394 | |||
395 | OIDplus::baseConfig()->setValue('JWT_ALLOW_AJAX_ADMIN', true); |
||
396 | Allow JWT tokens that were created using the admin-plugin |
||
397 | "Automated AJAX calls". |
||
398 | |||
399 | OIDplus::baseConfig()->setValue('JWT_ALLOW_AJAX_USER', true); |
||
400 | Allow JWT tokens that were created using the RA-plugin |
||
401 | "Automated AJAX calls". |
||
402 | |||
403 | OIDplus::baseConfig()->setValue('JWT_ALLOW_LOGIN_ADMIN', true); |
||
579 | daniel-mar | 404 | Allow "Remember me" logins for the administrator account. |
572 | daniel-mar | 405 | |
406 | OIDplus::baseConfig()->setValue('JWT_ALLOW_LOGIN_USER', true); |
||
579 | daniel-mar | 407 | Allow "Remember me" logins for a RA. |
572 | daniel-mar | 408 | |
585 | daniel-mar | 409 | OIDplus::baseConfig()->setValue('JWT_ALLOW_MANUAL', false); |
572 | daniel-mar | 410 | Allow JWT tokens which were manually created "by hand". |
411 | These can have any content you like, but they must |
||
412 | contain the claim "oidplus_generator" with value "2". |
||
583 | daniel-mar | 413 | |
414 | OIDplus::baseConfig()->setValue('JWT_TTL_LOGIN_USER', 10*365*24*60*60); |
||
415 | How many seconds will a "remember me" login JWT token be valid? |
||
416 | (RA login) |
||
417 | |||
418 | OIDplus::baseConfig()->setValue('JWT_TTL_LOGIN_ADMIN', 10*365*24*60*60); |
||
419 | How many seconds will a "remember me" login JWT token be valid? |
||
420 | (Administrator login) |
||
1036 | daniel-mar | 421 | |
422 | |||
423 | ---------------------------------------------------- |
||
424 | (8) THIRD-PARTY PLUGINS |
||
425 | ---------------------------------------------------- |
||
426 | |||
427 | OIDplus::baseConfig()->setValue('RDAP_CACHE_ENABLED', false ); |
||
428 | OIDplus::baseConfig()->setValue('RDAP_CACHE_DIRECTORY', OIDplus::localpath().'userdata/cache/' ); |
||
429 | OIDplus::baseConfig()->setValue('RDAP_BASE_URI', OIDplus::webpath() ); |
||
430 | OIDplus::baseConfig()->setValue('RDAP_CACHE_EXPIRES', 60 * 3 ); |