dolibarr  18.0.0-beta
conf.php.example
1 <?php
2 // Dolibarr example for conf.php file
3 //
4 // Do not edit this file without changing its name.
5 // This file is an example of empty config file for Dolibarr that can be used to create "conf.php".
6 //
7 // Warning: Be sure not to add line feed or spaces after closing php tag!
8 
9 
10 //###################
11 // Main parameters
12 //###################
13 
14 // dolibarr_main_url_root
15 // ======================
16 // This parameter defines the root URL of your Dolibarr index.php page without ending "/".
17 // It must link to the directory htdocs
18 // In most cases, this is autodetected but it's still required
19 // * to show full url bookmarks for some services (ie: agenda rss export url, ...)
20 // * or when using Apache dir aliases (autodetect fails)
21 // * or when using nginx (autodetect fails)
22 //
23 // Examples:
24 // $dolibarr_main_url_root='http://localhost';
25 // $dolibarr_main_url_root='http://mydolibarrvirtualhost';
26 // $dolibarr_main_url_root='http://myserver/dolibarr/htdocs';
27 // $dolibarr_main_url_root='http://myserver/dolibarralias';
28 //
29 $dolibarr_main_url_root='';
30 
31 
32 // dolibarr_main_document_root
33 // ===========================
34 // This parameter contains absolute file system path of Dolibarr htdocs directory
35 //
36 // Examples:
37 // $dolibarr_main_document_root='/var/www/dolibarr/htdocs';
38 // $dolibarr_main_document_root='C:/My web sites/dolibarr/htdocs';
39 //
40 $dolibarr_main_document_root='';
41 
42 
43 // dolibarr_main_url_root_alt
44 // ==========================
45 // This parameter defines the relative sub URLs to add to $dolibarr_main_url_root to
46 // forge alternative root directories (used by modules developers).
47 // You can put several values, separated by a coma, but number of entries must match
48 // number of entries into $dolibarr_main_document_root_alt.
49 //
50 // Examples:
51 // $dolibarr_main_url_root_alt='/custom';
52 // $dolibarr_main_url_root_alt='/extensions1,/extensions2';
53 //
54 //$dolibarr_main_url_root_alt='/custom';
55 
56 
57 // dolibarr_main_document_root_alt
58 // ===============================
59 // This parameter contains absolute alternative root file system directories (used by modules developers).
60 // You can put several values, separated by a coma, but number of entries must match
61 // number of entries into $dolibarr_main_url_root_alt.
62 //
63 // Examples:
64 // $dolibarr_main_document_root_alt='/var/www/dolibarr/htdocs/custom';
65 // $dolibarr_main_document_root_alt='C:/My web sites/dolibarr/htdocs/extensions1,C:/My web sites/dolibarr/htdocs/extensions2';
66 //
67 //$dolibarr_main_document_root_alt='/var/www/dolibarr/htdocs/custom';
68 
69 
70 // dolibarr_main_data_root
71 // =======================
72 // This parameter contains absolute file system directory of Dolibarr
73 // directory used to store uploaded and generated physical files.
74 //
75 // Examples:
76 // $dolibarr_main_data_root='/var/www/dolibarr/documents';
77 // $dolibarr_main_data_root='E:/My web sites/dolibarr/documents';
78 //
79 $dolibarr_main_data_root='';
80 
81 
82 // dolibarr_main_db_host
83 // =====================
84 // This parameter contains host name or ip address of Dolibarr database server.
85 //
86 // Examples:
87 // $dolibarr_main_db_host='localhost';
88 // $dolibarr_main_db_host='127.0.0.1';
89 // $dolibarr_main_db_host='192.168.0.10';
90 // $dolibarr_main_db_host='mysql.myserver.com';
91 //
92 $dolibarr_main_db_host='';
93 
94 
95 // dolibarr_main_db_port
96 // =====================
97 // This parameter contains the port of the Dolibarr database.
98 //
99 // Default value: none
100 // Examples:
101 // $dolibarr_main_db_host='3306';
102 //
103 $dolibarr_main_db_port='';
104 
105 
106 // dolibarr_main_db_name
107 // =====================
108 // This parameter contains name of Dolibarr database.
109 //
110 // Examples:
111 // $dolibarr_main_db_name='dolibarr';
112 // $dolibarr_main_db_name='mydatabase';
113 //
114 $dolibarr_main_db_name='';
115 
116 
117 // dolibarr_main_db_user
118 // =====================
119 // This parameter contains user name used to read and write into Dolibarr database.
120 //
121 // Examples:
122 // $dolibarr_main_db_user='admin';
123 // $dolibarr_main_db_user='dolibarruser';
124 //
125 $dolibarr_main_db_user='';
126 
127 
128 // dolibarr_main_db_pass
129 // =====================
130 // This parameter contains password used to read and write into Dolibarr database.
131 //
132 // Examples:
133 // $dolibarr_main_db_pass='myadminpass';
134 // $dolibarr_main_db_pass='myuserpassword';
135 //
136 $dolibarr_main_db_pass='';
137 
138 
139 // dolibarr_main_db_type
140 // =====================
141 // This parameter contains the name of the driver used to access your Dolibarr database.
142 //
143 // Default value: none
144 // Possible values: mysqli, pgsql
145 // Examples:
146 // $dolibarr_main_db_type='mysqli';
147 // $dolibarr_main_db_type='pgsql';
148 //
149 $dolibarr_main_db_type='';
150 
151 
152 // dolibarr_main_db_character_set
153 // ==============================
154 // Database character set used to store data (forced during database creation. value of database is then used).
155 //
156 // Default value: depends on database driver
157 // Examples:
158 // dolibarr_main_db_character_set='utf8';
159 //
160 $dolibarr_main_db_character_set='utf8';
161 
162 
163 // dolibarr_main_db_collation
164 // ==========================
165 // Database character set used to sort data (forced during database creation. value of database is then used).
166 //
167 // Default value: depends on database driver
168 // Examples:
169 // $dolibarr_main_db_collation='utf8_unicode_ci';
170 //
171 $dolibarr_main_db_collation='utf8_unicode_ci';
172 
173 
174 // dolibarr_main_db_readonly
175 // =========================
176 // Set this to 1 to have the application working in readonly mode. All SQL commands INSERT/UPDATE/DELETE/CREATE/ALTER/TRUNCATE/DROP will be disabled.
177 // Default value: 0
178 // Examples:
179 // $dolibarr_main_db_readonly='0';
180 //
181 $dolibarr_main_db_readonly=0;
182 
183 
184 // dolibarr_main_instance_unique_id
185 // ================================
186 // An secret ID that is unique for each installation.
187 // This value is also visible and never propagated outside of Dolibarr, so it can be used as a salt / key for some encryption (For example to get
188 // a unique hashed key, application will hash the value concatenated with a string. Example: md5('dolibarr'+dolibarr_main_instance_unique_id)
189 // WARNING: Changing this value will also make some sensitive values encrypted in database wrong.
190 // Default value: randomly defined during installation
191 // Examples:
192 // $dolibarr_main_instance_unique_id='84b5bc91f83b56e458db71e0adac2b62';
193 //
194 $dolibarr_main_instance_unique_id='84b5bc91f83b56e458db71e0adac2b62';
195 
196 
197 
198 //##################
199 // Login
200 //##################
201 
202 // dolibarr_main_authentication
203 // ============================
204 // This parameter contains the way authentication is done.
205 // If value "ldap" is used, you must also set parameters dolibarr_main_auth_ldap_*
206 // Default value: 'dolibarr'
207 // Possible values: Any values found in files in htdocs/core/login directory after
208 // the "function_" string and before the ".php" string. You can also separate several
209 // values using a ",". In this case, Dolibarr will check login/pass for each value in
210 // order defined into value. However, note that this can't work with all values.
211 // Examples:
212 // $dolibarr_main_authentication='dolibarr'; // Use the password defined into application on user file (default).
213 // $dolibarr_main_authentication='http'; // Use the HTTP Basic authentication
214 // $dolibarr_main_authentication='ldap'; // Check the password into a LDAP server
215 // $dolibarr_main_authentication='ldap,dolibarr'; // You can set several mode using a comma as a separator.
216 // $dolibarr_main_authentication='forceuser'; // This need to add also $dolibarr_auto_user='loginforuser';
217 // $dolibarr_main_authentication='twofactor'; // To use Google Authenticator. This need the non official external module "Two Factor" available on www.dolistore.com
218 // $dolibarr_main_authentication='openid_connect'; // See https://wiki.dolibarr.org/index.php?title=Authentication,_SSO_and_SSL
219 // $dolibarr_main_authentication='googleoauth'; // See https://wiki.dolibarr.org/index.php?title=Authentication,_SSO_and_SSL
220 //
221 $dolibarr_main_authentication='dolibarr';
222 
223 
224 // Parameters used to setup LDAP authentication
225 // --------------------------------------------
226 // Uncomment them if dolibarr_main_authentication = 'ldap'
227 //
228 // $dolibarr_main_auth_ldap_host='127.0.0.1'; // You can define several servers here separated with a comma.
229 // $dolibarr_main_auth_ldap_port='389'; // Port
230 // $dolibarr_main_auth_ldap_version='3'; // Version of LDAP
231 // $dolibarr_main_auth_ldap_servertype='openldap'; // openldap, activedirectory or egroupware
232 // $dolibarr_main_auth_ldap_login_attribute='loginfield'; // Ex: uid or samaccountname for active directory
233 // $dolibarr_main_auth_ldap_dn='ou=users,dc=my-domain,dc=com'; // Ex: ou=users,dc=my-domain,dc=com
234 // $dolibarr_main_auth_ldap_filter = ''; // If defined, the two previous parameters (dolibarr_main_auth_ldap_login_attribute and dolibarr_main_auth_ldap_dn) are not used to find a user into LDAP. Instead we use this search string. Ex: (uid=%1%) or &(uid=%1%)(isMemberOf=cn=Sales,ou=Groups,dc=opencsi,dc=com).
235 // $dolibarr_main_auth_ldap_admin_login=''; // Required only if anonymous bind disabled. Ex: cn=admin,dc=example,dc=com
236 // $dolibarr_main_auth_ldap_admin_pass=''; // Required only if anonymous bind disabled. Ex: secret
237 // $dolibarr_main_auth_ldap_debug='false';
238 
239 
240 // dolibarr_main_demo
241 // Login and pass to use in a demo mode
242 // Default value: ''
243 // Examples:
244 // $dolibarr_main_demo='autologin,autopass'
245 
246 
247 
248 //##################
249 // Security
250 //##################
251 
252 // dolibarr_main_force_https
253 // =========================
254 // This parameter allows to force the HTTPS mode.
255 // 0 = No forced redirect
256 // 1 = Force redirect to https, until SCRIPT_URI start with https into response
257 // 2 = Force redirect to https, until SERVER["HTTPS"] is 'on' into response
258 // 'https://my.domain.com' = Force redirect to https using this domain name.
259 // Warning: If you enable this parameter, your web server must be configured to respond URL with https protocol.
260 // According to your web server setup, some values may works and other not. Try different values (1,2 or 'https://my.domain.com') if you experience problems.
261 // Even if a redirect to HTTPS is forced by the webserver, it is recommanded to set this value to another value than 0, so your session cookies will be
262 // flagged as secured.
263 // Default value: 0
264 // Possible values: 0, 1, 2 or 'https://my.domain.com'
265 // Examples:
266 // $dolibarr_main_force_https='1';
267 //
268 $dolibarr_main_force_https='0';
269 
270 // dolibarr_main_prod
271 // ==================
272 // When this parameter is defined, all errors messages are not reported.
273 // This feature exists for production usage to avoid to give any information to hackers.
274 // Default value: 1
275 // Possible values: 0 or 1
276 // Examples:
277 // $dolibarr_main_prod='1';
278 //
279 $dolibarr_main_prod='1';
280 
281 // dolibarr_main_restrict_os_commands
282 // ==================================
283 // To restrict commands you can execute by the backup feature, enter allowed command here.
284 // Note: If you can, defining permission on OS linux (using SELinux for example) may be a better choice.
285 // Default value: 'mysqldump, mysql, pg_dump, pgrestore'
286 // Examples:
287 // $dolibarr_main_restrict_os_commands='mysqldump, /usr/local/bin/otherdumptool';
288 //
289 $dolibarr_main_restrict_os_commands='mysqldump, mysql, pg_dump, pgrestore';
290 
291 // dolibarr_main_restrict_ip
292 // =========================
293 // To restrict access to backoffice to some ip addresses only. Use a comma to separate values.
294 // Note: Pages that does not need login (like public pages, web site) are not protected with this.
295 // Default value: ''
296 // Examples:
297 // $dolibarr_main_restrict_ip='127.0.0.1, ::1, 192.168.0.1';
298 //
299 $dolibarr_main_restrict_ip='';
300 
301 // dolibarr_nocsrfcheck
302 // ====================
303 // This parameter can be used to disable CSRF protection.
304 // This might be required if you access Dolibarr behind a proxy that make bad URL rewriting, to avoid false alarms.
305 // In most cases, you should always keep this to 0.
306 // Default value: 0
307 // Possible values: 0 or 1 (no strict CSRF test, only test on referer) or 2 (no CSRF test at all)
308 // Examples:
309 // $dolibarr_nocsrfcheck='0';
310 //
311 $dolibarr_nocsrfcheck='0';
312 
313 // dolibarr_cron_allow_cli
314 // =======================
315 // If set to 1, you will be able to define some command line in the internale Job scheduler module.
316 // Default value: '0'
317 // Examples: '1'
318 //
319 $dolibarr_cron_allow_cli='0';
320 
321 // dolibarr_mailing_limit_sendbyweb
322 // ================================
323 // Can set a limit for mailing send by web. This overwrite database value. Can be used to restrict on system level.
324 // Default value: '25'
325 // Examples: '-1' (sending by web is forbidden)
326 //
327 // $dolibarr_mailing_limit_sendbyweb='25';
328 
329 // dolibarr_mailing_limit_sendbycli
330 // ================================
331 // Can set a limit for mailing send by cli. This overwrite database value. Can be used to restrict on system level.
332 // Default value: '0' (no hard limit, use soft database value if exists)
333 // Examples: '-1' (sending by cli is forbidden)
334 //
335 // $dolibarr_mailing_limit_sendbycli='0';
336 
337 // MAIN_ANTIVIRUS_COMMAND (as a constant)
338 // ======================
339 // Force a value for the antivirus command line tool so setup for admin user interface has no effect.
340 // Default value: ''
341 // Example: '/usr/bin/clamdscan';
342 // define('MAIN_ANTIVIRUS_COMMAND', '/usr/bin/clamdscan');
343 
344 // MAIN_ANTIVIRUS_PARAM (as a constant)
345 // ====================
346 // Force a value for the antivirus parameters on command line so setup for admin user interface has no effect.
347 // Default value: ''
348 // Example: '--fdpass';
349 // define('MAIN_ANTIVIRUS_PARAM', '--fdpass');
350 
351 // php_session_save_handler
352 // ========================
353 // Try to use the Dolibarr internal session handler that uses a database instead of the PHP handler (experimental).
354 // If you enable this feature to 'db', you may also want to enable the following constants:
355 // $dolibarr_session_db_type, $dolibarr_session_db_host, $dolibarr_session_db_user, $dolibarr_session_db_pass
356 // $dolibarr_session_db_pass, $dolibarr_session_db_name, $dolibarr_session_db_type = $dolibarr_main_db_port
357 // Default value: ''
358 // Example: 'db';
359 //
360 // $php_session_save_handler='';
361 
362 // force_install_lockinstall
363 // =========================
364 // If this value is set to a value, it forces the creation of a file install.lock once an upgrade process into a new version end.
365 // The value is the octal value of permission to set on created file.
366 // The file install.lock prevents the use of the migration process another time. You will have to delete it manually for
367 // next upgrade.
368 // Default value: '0'
369 // Example: '444';
370 // $force_install_lockinstall='440';
371 
372 
373 
374 //##################
375 // Other
376 //##################
377 
378 // dolibarr_main_db_prefix
379 // =======================
380 // This parameter contains prefix of Dolibarr database.
381 // Default value: 'llx_' if not defined
382 // Examples:
383 // $dolibarr_main_db_prefix='llx_';
384 
385 // dolibarr_main_limit_users
386 // =========================
387 // Can set a limit on the number of users it will be possible to create
388 // (the superadmin not included). Can be used for a restricted mode.
389 // Default value: 0 (unlimited)
390 // Examples:
391 // $dolibarr_main_limit_users='0';
392 
393 // dolibarr_strict_mode
394 // ====================
395 // Set this to 1 to enable the PHP strict mode. For dev environment only.
396 // Default value: 0 (use database value if exist)
397 // Examples:
398 // $dolibarr_strict_mode=0;
399 
400 // dolibarr_allow_download_external_modules
401 // ========================================
402 // Provide a link to download the zip of an external modules installed into custom directory from the web admin.
403 // Default value: 0
404 // Examples:
405 // $dolibarr_allow_download_external_modules=0;
406 
407 
408 
409 //#################################
410 // Path to external libraries/fonts
411 //#################################
412 
413 // Value to overwrite path to use shared libraries instead of embedded one
414 //$dolibarr_lib_TCPDF_PATH='/usr/share/php/tcpdf';
415 //$dolibarr_lib_FPDI_PATH='/usr/share/php/fpdi';
416 //$dolibarr_lib_FPDF_PATH='/usr/share/php/fpdf';
417 //$dolibarr_lib_GEOIP_PATH='';
418 //$dolibarr_lib_NUSOAP_PATH='/usr/share/php/nusoap';
419 //$dolibarr_lib_ODTPHP_PATH='';
420 //$dolibarr_lib_ODTPHP_PATHTOPCLZIP="/usr/share/php/libphp-pclzip";
421 
422 // Value to overwrite path to use shared javascript instead of embedded one
423 //$dolibarr_js_CKEDITOR='/javascript/ckeditor';
424 //$dolibarr_js_JQUERY='/javascript/jquery';
425 //$dolibarr_js_JQUERY_UI='/javascript/jquery-ui';
426 
427 // Value to overwrite some path to use font instead of embedded one
428 //$dolibarr_font_DOL_DEFAULT_TTF="/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans.ttf";
429 //$dolibarr_font_DOL_DEFAULT_TTF_BOLD="/usr/share/fonts/truetype/ttf-dejavu/DejaVuSans-Bold.ttf";
430 
431 
432 //##############################
433 // External modules
434 //##############################
435 
436