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