Rev 290 | 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 | Old 2.0 format: define('OIDPLUS_CONFIG_VERSION', 2.0); |
||
26 | |||
27 | OIDplus::baseConfig()->setValue('ADMIN_PASSWORD', '<base64 encoded SHA3-512 hash>'); |
||
28 | Old 2.0 format: define('OIDPLUS_ADMIN_PASSWORD', '<base64 encoded SHA3-512 hash>'); |
||
29 | |||
30 | OIDplus::baseConfig()->setValue('DATABASE_PLUGIN', ''); |
||
31 | Old 2.0 format: define('OIDPLUS_DATABASE_PLUGIN', ''); |
||
32 | |||
33 | OIDplus::baseConfig()->setValue('ODBC_DSN', 'DRIVER={SQL Server};SERVER=localhost;DATABASE=oidplus;CHARSET=UTF8'); |
||
34 | Old 2.0 format: define('OIDPLUS_ODBC_DSN', 'DRIVER={SQL Server};SERVER=localhost;DATABASE=oidplus;CHARSET=UTF8'); |
||
35 | |||
36 | OIDplus::baseConfig()->setValue('ODBC_USERNAME', 'sa'); |
||
37 | Old 2.0 format: define('OIDPLUS_ODBC_USERNAME', 'sa'); |
||
38 | |||
39 | OIDplus::baseConfig()->setValue('ODBC_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
40 | Old 2.0 format: define('OIDPLUS_ODBC_PASSWORD', '<base64_encoded_password>'); // must be base64 encoded |
||
41 | Information: The base64 encoding "protects" your password from being read if |
||
42 | someone quickly looks at your display while you have the configuration file opened. |
||
43 | |||
44 | OIDplus::baseConfig()->setValue('PDO_DSN', 'pgsql:host=localhost;dbname=oidplus'); |
||
45 | Old 2.0 format: define('OIDPLUS_PDO_DSN', 'pgsql:host=localhost;dbname=oidplus'); |
||
46 | |||
47 | OIDplus::baseConfig()->setValue('PDO_USERNAME', 'postgres'); |
||
48 | Old 2.0 format: define('OIDPLUS_PDO_USERNAME', 'postgres'); |
||
49 | |||
50 | OIDplus::baseConfig()->setValue('PDO_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
51 | Old 2.0 format: define('OIDPLUS_PDO_PASSWORD', '<base64_encoded_password>'); // must be base64 encoded |
||
52 | Information: The base64 encoding "protects" your password from being read if |
||
53 | someone quickly looks at your display while you have the configuration file opened. |
||
54 | |||
55 | OIDplus::baseConfig()->setValue('MYSQL_HOST', 'localhost:3306'); |
||
56 | Old 2.0 format: define('OIDPLUS_MYSQL_HOST', 'localhost:3306'); |
||
57 | Information: Port is optional |
||
58 | |||
59 | OIDplus::baseConfig()->setValue('MYSQL_USERNAME', 'root'); |
||
60 | Old 2.0 format: define('OIDPLUS_MYSQL_USERNAME', 'root'); |
||
61 | |||
62 | OIDplus::baseConfig()->setValue('MYSQL_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
63 | Old 2.0 format: define('OIDPLUS_MYSQL_PASSWORD', '<base64_encoded_password>'); // must be base64 encoded |
||
64 | Information: The base64 encoding "protects" your password from being read if |
||
65 | someone quickly looks at your display while you have the configuration file opened. |
||
66 | |||
67 | OIDplus::baseConfig()->setValue('MYSQL_DATABASE', 'oidplus'); |
||
68 | Old 2.0 format: define('OIDPLUS_MYSQL_DATABASE', 'oidplus'); |
||
69 | |||
70 | OIDplus::baseConfig()->setValue('PGSQL_HOST', 'localhost:5432'); |
||
71 | Old 2.0 format: define('OIDPLUS_PGSQL_HOST', 'localhost:5432'); |
||
72 | Information: Port is optional |
||
73 | |||
74 | OIDplus::baseConfig()->setValue('PGSQL_USERNAME', 'postgres'); |
||
75 | Old 2.0 format: define('OIDPLUS_PGSQL_USERNAME', 'postgres'); |
||
76 | |||
77 | OIDplus::baseConfig()->setValue('PGSQL_PASSWORD', base64_decode('<base64_encoded_password>')); // alternatively as plaintext |
||
78 | Old 2.0 format: define('OIDPLUS_PGSQL_PASSWORD', '<base64_encoded_password>'); // must be base64 encoded |
||
79 | Information: The base64 encoding "protects" your password from being read if |
||
80 | someone quickly looks at your display while you have the configuration file opened. |
||
81 | |||
82 | OIDplus::baseConfig()->setValue('PGSQL_DATABASE', 'oidplus'); |
||
83 | Old 2.0 format: define('OIDPLUS_PGSQL_DATABASE', 'oidplus'); |
||
84 | |||
264 | daniel-mar | 85 | |
294 | daniel-mar | 86 | OIDplus::baseConfig()->setValue('SQLITE3_FILE', 'userdata/database/oidplus.db'); |
87 | Old 2.0 format: define('OIDPLUS_SQLITE3_FILE', 'userdata/database/oidplus.db'); |
||
264 | daniel-mar | 88 | Attention: This file must be located in a location that is not world-readable/downloadable! |
89 | |||
90 | OIDplus::baseConfig()->setValue('SQLITE3_ENCRYPTION', ''); |
||
91 | Old 2.0 format: define('OIDPLUS_SQLITE3_ENCRYPTION', ''); |
||
92 | Note: Options |
||
93 | |||
261 | daniel-mar | 94 | OIDplus::baseConfig()->setValue('TABLENAME_PREFIX', 'oidplus_'); |
95 | Old 2.0 format: define('OIDPLUS_TABLENAME_PREFIX', 'oidplus_'); |
||
96 | |||
97 | OIDplus::baseConfig()->setValue('SERVER_SECRET', 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); |
||
98 | Old 2.0 format: define('OIDPLUS_SESSION_SECRET', 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'); |
||
99 | Information: It is very very important that you choose a long sequence of |
||
100 | random characters. OIDplus uses this secret for various |
||
101 | security related purposes. If someone accidently received this secret, |
||
102 | please change the sequence. |
||
103 | |||
104 | OIDplus::baseConfig()->setValue('RECAPTCHA_ENABLED', true); |
||
105 | Old 2.0 format: define('RECAPTCHA_ENABLED', 0); |
||
106 | |||
107 | OIDplus::baseConfig()->setValue('RECAPTCHA_PUBLIC', ''); |
||
108 | Old 2.0 format: define('RECAPTCHA_PUBLIC', ''); |
||
109 | |||
110 | OIDplus::baseConfig()->setValue('RECAPTCHA_PRIVATE', ''); |
||
111 | Old 2.0 format: define('RECAPTCHA_PRIVATE', ''); |
||
112 | |||
113 | OIDplus::baseConfig()->setValue('ENFORCE_SSL', 2); |
||
114 | Old 2.0 format: define('OIDPLUS_ENFORCE_SSL', 2); |
||
115 | Information: Values 0 (off), 1 (on), 2 (auto detect) |
||
116 | |||
117 | |||
118 | ---------------------- |
||
119 | (2) SYSTEM LIMITATIONS (defined and documented in includes/limits.inc.php , can be overwritten by config.inc.php) |
||
120 | ---------------------- |
||
121 | |||
122 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_DEPTH', 30); |
||
123 | Old 2.0 format: define('OIDPLUS_MAX_OID_DEPTH', 30); |
||
124 | Information: Please read the documentation in the file includes/limits.inc.php |
||
125 | |||
126 | OIDplus::baseConfig()->setValue('LIMITS_MAX_ID_LENGTH', 255); |
||
127 | Old 2.0 format: define('OIDPLUS_MAX_OID_ARC_SIZE', 255); |
||
128 | Information: Please read the documentation in the file includes/limits.inc.php |
||
129 | |||
130 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_ARC_SIZE', 50); |
||
131 | Old 2.0 format: define('OIDPLUS_MAX_OID_ARC_SIZE', 50); |
||
132 | Information: Please read the documentation in the file includes/limits.inc.php |
||
133 | |||
134 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_ASN1_ID_LEN', 255); |
||
135 | Old 2.0 format: define('OIDPLUS_MAX_OID_ASN1_ID_LEN', 255); |
||
136 | Information: Please read the documentation in the file includes/limits.inc.php |
||
137 | |||
138 | OIDplus::baseConfig()->setValue('LIMITS_MAX_OID_UNICODE_LABEL_LEN', 255); |
||
139 | Old 2.0 format: define('OIDPLUS_MAX_OID_UNICODE_LABEL_LEN', 255); |
||
140 | Information: Please read the documentation in the file includes/limits.inc.php |
||
141 | |||
142 | |||
143 | ----------------------------------------- |
||
144 | (3) "HIDDEN"/UNDOCUMENTED CONFIG SETTINGS |
||
145 | ----------------------------------------- |
||
146 | |||
147 | OIDplus::baseConfig()->setValue('OIDINFO_SECRET_ADMIN_USERNAME', '<email address>'); |
||
148 | Old 2.0 format: define('OIDINFO_SECRET_ADMIN_USERNAME', '<email address>'); |
||
149 | Information: Currently only internal use for development utilities (dev/). |
||
150 | |||
151 | OIDplus::baseConfig()->setValue('OIDINFO_SECRET_ADMIN_PASSWORD', '<plaintext password>'); |
||
152 | Old 2.0 format: define('OIDINFO_SECRET_ADMIN_PASSWORD', '<plaintext password>'); |
||
153 | Information: Currently only internal use for development utilities (dev/). |
||
154 | |||
155 | OIDplus::baseConfig()->setValue('OIDINFO_API_URL', '<url>'); |
||
156 | Old 2.0 format: define('OIDINFO_API_URL', '<url>'); |
||
157 | Information: Currently only internal use for development utilities (dev/). |
||
158 | |||
159 | OIDplus::baseConfig()->setValue('REGISTRATION_HIDE_SYSTEM', true); |
||
160 | Old 2.0 format: define('REGISTRATION_HIDE_SYSTEM', true); |
||
161 | Information: Set this if you have a clone of a productive system and you want |
||
162 | to avoid that the clone registers at the ViaThinkSoft directory |
||
163 | (which would overwrite the URL of the productive system and reveal |
||
164 | the URL of your testing system) |
||
165 | |||
166 | OIDplus::baseConfig()->setValue('MYSQL_FORCE_MYSQLND_SUPPLEMENT', false); |
||
167 | Old 2.0 format: define('OIDPLUS_MYSQL_FORCE_MYSQLND_SUPPLEMENT', false); |
||
168 | Information: The MySQLi plugin contains a supplement code to handle |
||
169 | prepared statements on servers which do not have the MySQLnd extension |
||
170 | installed. Set this flag to force the supplement to be used, |
||
171 | even if MySQLnd is available. (For testing purposes only) |
||
172 | |||
173 | OIDplus::baseConfig()->setValue('QUERY_LOGFILE', ''); |
||
174 | Old 2.0 format: define('OIDPLUS_MYSQL_QUERYLOG', false); |
||
175 | Information: Set this setting to a filename where all queries including timestamps would be written. |
||
176 | This is used for performance analysis. |
||
177 | Please choose a directory that cannot be accessed by world-wide. |
||
178 | |||
179 | OIDplus::baseConfig()->setValue('SESSION_LIFETIME', 30*60); |
||
180 | Old 2.0 format: define('SESSION_LIFETIME', 30*60); |
||
181 | Information: Session lifetime in seconds. |
||
182 | |||
183 | OIDplus::baseConfig()->setValue('OBJECT_CACHING', true); |
||
184 | Old 2.0 format: define('OIDPLUS_OBJECT_CACHING', true); |
||
185 | |||
186 | OIDplus::baseConfig()->setValue('FORCE_DBMS_SLANG', ''); |
||
187 | Old 2.0 format: define('DBMS_SLANG', ''); |
||
264 | daniel-mar | 188 | Information: Currently valid values: mysql, mssql, pgsql, sqlite |
261 | daniel-mar | 189 | |
190 | OIDplus::baseConfig()->setValue('MINIFY_CSS', true); |
||
191 | Old 2.0 format: define('DO_MINIFY', true); |
||
192 | |||
193 | OIDplus::baseConfig()->setValue('MINIFY_JS', true); |
||
194 | Old 2.0 format: (Not available) |
||
195 | |||
196 | OIDplus::baseConfig()->setValue('DISABLE_MSIE_COMPAT', false); |
||
197 | Old 2.0 format: define('DISABLE_MSIE_COMPAT', false); |
||
198 | Information: Set to "true" if you want to avoid that the external polyfill |
||
199 | JavaScript will be included if Internet Explorer is detected. |
||
200 | Only recommended if you have concerns about privacy. |