conf.php.example 15 KB

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