conf.php.example 18 KB

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