Rev 1001 | 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'); |
107 | |||
1016 | daniel-mar | 108 | OIDplus::baseConfig()->setValue('RECAPTCHA_VERSION', OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V2_CHECKBOX); |
109 | Possible values: |
||
110 | OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V2_CHECKBOX |
||
111 | OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V2_INVISIBLE |
||
112 | OIDplusCaptchaPluginRecaptcha::RECAPTCHA_V3 |
||
113 | |||
261 | daniel-mar | 114 | OIDplus::baseConfig()->setValue('RECAPTCHA_ENABLED', true); |
702 | daniel-mar | 115 | Deprecated! |
116 | RECAPTCHA_ENABLED=true becomes CAPTCHA_PLUGIN=ReCAPTCHA |
||
117 | RECAPTCHA_ENABLED=false becomes CAPTCHA_PLUGIN=None |
||
261 | daniel-mar | 118 | |
119 | OIDplus::baseConfig()->setValue('RECAPTCHA_PUBLIC', ''); |
||
713 | daniel-mar | 120 | Only used if CAPTCHA_PLUGIN=ReCAPTCHA |
261 | daniel-mar | 121 | |
122 | OIDplus::baseConfig()->setValue('RECAPTCHA_PRIVATE', ''); |
||
713 | daniel-mar | 123 | Only used if CAPTCHA_PLUGIN=ReCAPTCHA |
261 | daniel-mar | 124 | |
1001 | daniel-mar | 125 | OIDplus::baseConfig()->setValue('HCAPTCHA_SITEKEY', ''); |
126 | Only used if CAPTCHA_PLUGIN=hCaptcha |
||
127 | |||
128 | OIDplus::baseConfig()->setValue('HCAPTCHA_SECRET', ''); |
||
129 | Only used if CAPTCHA_PLUGIN=hCaptcha |
||
130 | |||
974 | daniel-mar | 131 | OIDplus::baseConfig()->setValue('ENFORCE_SSL', OIDplus::ENFORCE_SSL_AUTO); |
132 | Values OIDplus::ENFORCE_SSL_NO (0) = (off) |
||
133 | OIDplus::ENFORCE_SSL_YES (1) = (on) |
||
134 | OIDplus::ENFORCE_SSL_AUTO (2) = (auto detect SSL) |
||
261 | daniel-mar | 135 | |
136 | |||
137 | ---------------------- |
||
374 | daniel-mar | 138 | (2) SYSTEM LIMITATIONS (defined and documented in includes/oidplus_limits.inc.php , can be overwritten by config.inc.php) |
261 | daniel-mar | 139 | ---------------------- |
140 | |||
141 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_DEPTH', 30); |
||
713 | daniel-mar | 142 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 143 | |
144 | OIDplus::baseConfig()->setValue('LIMITS_MAX_ID_LENGTH', 255); |
||
713 | daniel-mar | 145 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 146 | |
147 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_ARC_SIZE', 50); |
||
713 | daniel-mar | 148 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 149 | |
150 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_ASN1_ID_LEN', 255); |
||
713 | daniel-mar | 151 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 152 | |
153 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_UNICODE_LABEL_LEN', 255); |
||
713 | daniel-mar | 154 | Please read the documentation in the file includes/oidplus_limits.inc.php |
261 | daniel-mar | 155 | |
156 | |||
157 | ----------------------------------------- |
||
158 | (3) "HIDDEN"/UNDOCUMENTED CONFIG SETTINGS |
||
159 | ----------------------------------------- |
||
160 | |||
161 | OIDplus::baseConfig()->setValue('OIDINFO_API_URL', '<url>'); |
||
713 | daniel-mar | 162 | Currently only internal use for development utilities (dev/). |
502 | daniel-mar | 163 | The API to oid-info.com is currently not public. |
261 | daniel-mar | 164 | |
165 | OIDplus::baseConfig()->setValue('REGISTRATION_HIDE_SYSTEM', true); |
||
713 | daniel-mar | 166 | Set this if you have a clone of a productive system and you want |
261 | daniel-mar | 167 | to avoid that the clone registers at the ViaThinkSoft directory |
168 | (which would overwrite the URL of the productive system and reveal |
||
169 | the URL of your testing system) |
||
170 | |||
171 | OIDplus::baseConfig()->setValue('MYSQL_FORCE_MYSQLND_SUPPLEMENT', false); |
||
713 | daniel-mar | 172 | The MySQLi plugin contains a supplement code to handle |
261 | daniel-mar | 173 | prepared statements on servers which do not have the MySQLnd extension |
174 | installed. Set this flag to force the supplement to be used, |
||
175 | even if MySQLnd is available. (For testing purposes only) |
||
176 | |||
177 | OIDplus::baseConfig()->setValue('QUERY_LOGFILE', ''); |
||
713 | daniel-mar | 178 | Set this setting to a filename where all queries including timestamps would be written. |
261 | daniel-mar | 179 | This is used for performance analysis. |
180 | Please choose a directory that cannot be accessed by world-wide. |
||
181 | |||
182 | OIDplus::baseConfig()->setValue('SESSION_LIFETIME', 30*60); |
||
713 | daniel-mar | 183 | Session lifetime in seconds. |
261 | daniel-mar | 184 | |
185 | OIDplus::baseConfig()->setValue('OBJECT_CACHING', true); |
||
186 | |||
187 | OIDplus::baseConfig()->setValue('FORCE_DBMS_SLANG', ''); |
||
713 | daniel-mar | 188 | Currently valid values: mysql, mssql, pgsql, sqlite |
261 | daniel-mar | 189 | |
502 | daniel-mar | 190 | OIDplus::baseConfig()->setValue('PREPARED_STATEMENTS_EMULATION', 'auto'); |
713 | daniel-mar | 191 | Currently only for ODBC database plugin. |
502 | daniel-mar | 192 | 'auto' = Auto detect if prepared statements should be emulated |
193 | 'on' = Always emulate prepared statements |
||
194 | 'off' = Never emulate prepared statements |
||
195 | |||
261 | daniel-mar | 196 | OIDplus::baseConfig()->setValue('MINIFY_CSS', true); |
417 | daniel-mar | 197 | This enables the compression of CSS definitions. |
198 | Compressed approx: 220 KB |
||
199 | Uncompressed approx: 224 KB |
||
261 | daniel-mar | 200 | |
201 | OIDplus::baseConfig()->setValue('MINIFY_JS', true); |
||
417 | daniel-mar | 202 | This enables the compression of JavaScript code. |
203 | Please only disable this, if you want to debug |
||
204 | the code! You should not disable it on a productive |
||
205 | system, because otherwise the JavaScript code |
||
206 | would be several Megabytes large. |
||
207 | Compressed approx: 1133 KB |
||
208 | Unompressed approx: 2761 KB |
||
261 | daniel-mar | 209 | |
297 | daniel-mar | 210 | OIDplus::baseConfig()->setValue('DISABLE_PLUGIN_...', true); |
713 | daniel-mar | 211 | This gives you the possibility to disable a plugin without |
297 | daniel-mar | 212 | requiring it to be removed from the file system. |
213 | (Removing a plugin from the file system can result in various |
||
214 | problems, e.g. they can be re-added during a SVN/software update.) |
||
215 | Replace "..." with the main PHP class of the plugin you want to disable |
||
216 | Example: |
||
217 | "DISABLE_PLUGIN_OIDplusLoggerPluginUserdataLogfile" |
||
218 | disables the plugin "logger/300_userdata_logfile". |
||
316 | daniel-mar | 219 | |
220 | OIDplus::baseConfig()->setValue('DISABLE_AJAX_TRANSACTIONS', false); |
||
221 | This will disable the usage of database transactions in ajax.php |
||
222 | Do only use this if you have severe problems with the system running. |
||
223 | It might result in inconsistent data e.g. if you update an OID |
||
224 | and an error occurs in the middle of that process. |
||
326 | daniel-mar | 225 | |
806 | daniel-mar | 226 | OIDplus::baseConfig()->setValue('CANONICAL_SYSTEM_URL', ''); |
227 | Setting this value to a system URL will override the absolute system URL detection. |
||
228 | It has the following effects: |
||
229 | 1. The "canonical" metatag will use this explicit system URL |
||
230 | instead of the one the PHP script is detecting. |
||
231 | (This is important to avoid duplicate content at search indexes) |
||
232 | 2. CLI WHOIS and other CLI (Command-line-interface) tools |
||
233 | will use this address when they need to output an URL. |
||
234 | Otherwise, the CLI tools would need to use the last known |
||
235 | URL that was detected when a webpage visitor has last visited the |
||
236 | page. |
||
237 | 3. While most resources (images, CSS files, scripts, etc.) are loaded |
||
238 | via relative URLs, sometimes an absolute URL is required |
||
239 | (e.g., if an email is sent with an activation link). |
||
240 | The explicit absolute system URL will then be used rather |
||
241 | than the automatically detected one. |
||
242 | Note that setting an absolute system URL can be very useful if |
||
243 | OIDplus runs on a system (which detects itself as "X"), |
||
807 | daniel-mar | 244 | while the canonical URL "Y" is a reverse-proxy. |
778 | daniel-mar | 245 | |
456 | daniel-mar | 246 | OIDplus::baseConfig()->setValue('DEBUG', false); |
247 | Enables some special checks for plugins (e.g. a self-test for auth plugins). |
||
248 | It is highly recommended that you enable DEBUG if you are developing |
||
249 | plugins! |
||
470 | daniel-mar | 250 | It is recommended to disable this switch in productive systems, |
251 | because the self-tests decrease the performance. |
||
252 | However, after installing a new plugin, you might want to enable |
||
253 | it for a few minutes, to make sure the plugin is working correctly. |
||
430 | daniel-mar | 254 | |
557 | daniel-mar | 255 | OIDplus::baseConfig()->setValue('COOKIE_SAMESITE_POLICY', 'Strict'); |
256 | Defined which "SameSite" policy should be used for the cookies OIDplus uses. |
||
257 | Can be "None", "Lax" or "Strict". |
||
258 | "Strict" is the most secure setting. |
||
259 | "Lax" allows that people stay logged in if they follow a link pointing |
||
260 | to your OIDplus installation. |
||
261 | "None" is not recommended and is deprecated by modern web browsers. |
||
262 | However, OIDplus itself provides an Anti-CSRF mechanism, so you should be |
||
263 | still safe. |
||
456 | daniel-mar | 264 | |
812 | daniel-mar | 265 | OIDplus::baseConfig()->setValue('COOKIE_DOMAIN', ''); |
266 | Can be used to increase security by setting an explicit domain-name in the cookies. |
||
267 | Set to '' (empty string) to allow all (sub)domains. |
||
268 | Set to '(auto)' to automatically detect the domain based on the absolute canonical path. |
||
269 | |||
270 | OIDplus::baseConfig()->setValue('COOKIE_PATH', '/'); |
||
271 | Can be used to increase security by setting an explicit pathname in the cookies. |
||
272 | Set to '/' to allow all paths. |
||
273 | Set to '(auto)' to automatically detect the path based on the absolute canonical path. |
||
274 | Note: If supported, you can use Apache's "ProxyPassReverseCookiePath" to translate |
||
275 | the cookie path in a reverse-proxy setting. |
||
276 | |||
713 | daniel-mar | 277 | OIDplus::baseConfig()->getValue('RA_PASSWORD_PEPPER', ''); |
617 | daniel-mar | 278 | The pepper is stored inside the base configuration file |
279 | It prevents that an attacker with SQL write rights can |
||
280 | create accounts. |
||
281 | ATTENTION!!! If a pepper is used, then the |
||
282 | hashes are bound to that pepper. If you change the pepper, |
||
283 | then ALL passwords of RAs become INVALID! |
||
557 | daniel-mar | 284 | |
713 | daniel-mar | 285 | OIDplus::baseConfig()->getValue('RA_PASSWORD_PEPPER_ALGO', 'sha512'); |
711 | daniel-mar | 286 | The pepper is stored inside the base configuration file |
287 | It prevents that an attacker with SQL write rights can |
||
288 | create accounts. |
||
289 | ATTENTION!!! If a pepper is used, then the |
||
290 | hashes are bound to that pepper. If you change the pepper, |
||
291 | then ALL passwords of RAs become INVALID! |
||
617 | daniel-mar | 292 | |
711 | daniel-mar | 293 | |
430 | daniel-mar | 294 | ---------------------------------------------------- |
295 | (4) LDAP FIELDS (see document ldap_installation.txt) |
||
296 | ---------------------------------------------------- |
||
297 | |||
620 | daniel-mar | 298 | OIDplus::baseConfig()->setValue('LDAP_ENABLED', true); |
299 | Set to true if you want to enable that users can log-in using LDAP / ActiveDirectory. |
||
432 | daniel-mar | 300 | |
625 | daniel-mar | 301 | OIDplus::baseConfig()->setValue('LDAP_NUM_DOMAINS', 1); |
302 | Contains the number of domains/servers which are used. |
||
303 | For 2nd, 3rd, 4th, ... domain use the fields LDAP_xxx__2, LDAP_xxx__3, ... |
||
304 | e.g. LDAP_SERVER__2 |
||
305 | LDAP_PORT__2 |
||
306 | LDAP_BASE_DN__2 |
||
307 | ... |
||
308 | |||
620 | daniel-mar | 309 | OIDplus::baseConfig()->setValue('LDAP_SERVER', 'ldap://server1.contoso.local'); |
310 | The LDAP server of your company. |
||
432 | daniel-mar | 311 | |
620 | daniel-mar | 312 | OIDplus::baseConfig()->setValue('LDAP_PORT', 389); |
313 | The port of the LDAP server |
||
314 | |||
315 | OIDplus::baseConfig()->setValue('LDAP_BASE_DN', 'DC=CONTOSO,DC=local'); |
||
316 | The base Distinguished Name (DN) of your directory. |
||
317 | |||
625 | daniel-mar | 318 | OIDplus::baseConfig()->setValue('LDAP_UPN_SUFFIX', '@contoso.local'); |
319 | The UPN suffix of this domain. |
||
320 | |||
321 | OIDplus::baseConfig()->setValue('LDAP_AUTHENTICATE_UPN', true); |
||
620 | daniel-mar | 322 | In the login mask, the users will log in using the UPN ("principal name") e.g. username@contoso.local, |
323 | and in OIDplus, a RA account with an email equal to the UPN will be created. |
||
324 | |||
325 | OIDplus::baseConfig()->setValue('LDAP_AUTHENTICATE_EMAIL', false); |
||
326 | In the login mask, the users will log in using the UPN ("principal name") e.g. username@contoso.local, |
||
327 | 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. |
||
328 | Note: If you did not set an email address to the user in the LDAP/ActiveDirectory, then the login will not be possible, |
||
329 | except if LDAP_AUTHENTICATE_UPN is additionally enabled. |
||
330 | Attention: Depending on your domain configuration, users might be able to change their own data, |
||
331 | e.g. email address. If this is the case, you must not enable this setting, otherwise, |
||
332 | users could authenticate with any address! |
||
333 | |||
623 | daniel-mar | 334 | OIDplus::baseConfig()->setValue('LDAP_ADMIN_GROUP', ''); |
335 | If set to an empty string, the OIDplus administrator account cannot be accessed using LDAP authentication. |
||
336 | Otherwise, the user will be authenticated as administrator, if the LDAP user is a |
||
624 | daniel-mar | 337 | member of the group specified in this setting. |
623 | daniel-mar | 338 | Example values: CN=Administrators,CN=Builtin,DC=CONTOSO,DC=local |
339 | makes every domain administrator also an OIDplus administrator |
||
340 | CN=OIDplus Administrators,CN=Users,DC=CONTOSO,DC=local |
||
341 | makes every user of the group (OIDplus Administrators) to OIDplus administrators |
||
342 | |||
343 | OIDplus::baseConfig()->setValue('LDAP_RA_GROUP', ''); |
||
344 | If set to an empty string, every LDAP user can authenticate as RA, depending |
||
345 | on whether LDAP_AUTHENTICATE_UPN and/or LDAP_AUTHENTICATE_EMAIL is set. |
||
624 | daniel-mar | 346 | Otherwise, the LDAP users must be a member of the group specified in this setting. |
620 | daniel-mar | 347 | |
348 | |||
432 | daniel-mar | 349 | ---------------------------------------------------------------------- |
350 | (5) GOOGLE OAUTH2 FIELDS (see document google_oauth2_installation.txt) |
||
351 | ---------------------------------------------------------------------- |
||
352 | |||
353 | OIDplus::baseConfig()->setValue('GOOGLE_OAUTH2_ENABLED', true); |
||
354 | OIDplus::baseConfig()->setValue('GOOGLE_OAUTH2_CLIENT_ID', '..............apps.googleusercontent.com'); |
||
355 | OIDplus::baseConfig()->setValue('GOOGLE_OAUTH2_CLIENT_SECRET', '.............'); |
||
436 | daniel-mar | 356 | |
357 | |||
358 | ------------------------------------------------------------------------- |
||
359 | (6) FACEBOOK OAUTH2 FIELDS (see document facebook_oauth2_installation.txt) |
||
360 | ------------------------------------------------------------------------- |
||
361 | |||
362 | OIDplus::baseConfig()->setValue('FACEBOOK_OAUTH2_ENABLED', true); |
||
363 | OIDplus::baseConfig()->setValue('FACEBOOK_OAUTH2_CLIENT_ID', '.............'); // Your App ID |
||
364 | OIDplus::baseConfig()->setValue('FACEBOOK_OAUTH2_CLIENT_SECRET', '.............'); // Your App Secret |
||
572 | daniel-mar | 365 | |
366 | |||
367 | ---------------------------------------------------- |
||
368 | (7) JWT AUTHENTICATION FIELDS |
||
369 | ---------------------------------------------------- |
||
370 | |||
371 | If a web request contains the field "OIDPLUS_AUTH_JWT" containing a signed JWT token, |
||
372 | an automatic one-time login is performed in order to execute commands. |
||
373 | This feature is used in the plugins "Automated AJAX calls" for admins and RAs. |
||
374 | With these switches you can disable this feature. |
||
375 | |||
376 | OIDplus::baseConfig()->setValue('JWT_ALLOW_AJAX_ADMIN', true); |
||
377 | Allow JWT tokens that were created using the admin-plugin |
||
378 | "Automated AJAX calls". |
||
379 | |||
380 | OIDplus::baseConfig()->setValue('JWT_ALLOW_AJAX_USER', true); |
||
381 | Allow JWT tokens that were created using the RA-plugin |
||
382 | "Automated AJAX calls". |
||
383 | |||
384 | OIDplus::baseConfig()->setValue('JWT_ALLOW_LOGIN_ADMIN', true); |
||
579 | daniel-mar | 385 | Allow "Remember me" logins for the administrator account. |
572 | daniel-mar | 386 | |
387 | OIDplus::baseConfig()->setValue('JWT_ALLOW_LOGIN_USER', true); |
||
579 | daniel-mar | 388 | Allow "Remember me" logins for a RA. |
572 | daniel-mar | 389 | |
585 | daniel-mar | 390 | OIDplus::baseConfig()->setValue('JWT_ALLOW_MANUAL', false); |
572 | daniel-mar | 391 | Allow JWT tokens which were manually created "by hand". |
392 | These can have any content you like, but they must |
||
393 | contain the claim "oidplus_generator" with value "2". |
||
583 | daniel-mar | 394 | |
395 | OIDplus::baseConfig()->setValue('JWT_TTL_LOGIN_USER', 10*365*24*60*60); |
||
396 | How many seconds will a "remember me" login JWT token be valid? |
||
397 | (RA login) |
||
398 | |||
399 | OIDplus::baseConfig()->setValue('JWT_TTL_LOGIN_ADMIN', 10*365*24*60*60); |
||
400 | How many seconds will a "remember me" login JWT token be valid? |
||
401 | (Administrator login) |