3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * CiviCRM Configuration File.
31 global $civicrm_root, $civicrm_setting, $civicrm_paths;
34 * Content Management System (CMS) Host:
36 * CiviCRM can be hosted in either Drupal 6 or 7, Joomla or WordPress.
38 * Settings for Backdrop CMS:
39 * define( 'CIVICRM_UF' , 'Backdrop');
41 * Settings for Drupal 7.x:
42 * define( 'CIVICRM_UF' , 'Drupal');
44 * Settings for Drupal 6.x:
45 * define( 'CIVICRM_UF' , 'Drupal6');
47 * Settings for Joomla 1.7.x - 2.5.x:
48 * define( 'CIVICRM_UF' , 'Joomla');
50 * Settings for WordPress 3.3.x:
51 * define( 'CIVICRM_UF' , 'WordPress');
53 * You may have issues with images in CiviCRM. If this is the case, be sure
54 * to update the CiviCRM Resource URL field to your CiviCRM root directory
55 * (Administer::System Settings::Resource URLs).
57 if (!defined('CIVICRM_UF')) {
58 if (getenv('CIVICRM_UF')) {
59 define('CIVICRM_UF', getenv('CIVICRM_UF'));
62 define('CIVICRM_UF', '%%cms%%');
67 * Content Management System (CMS) Datasource:
69 * Update this setting with your CMS (Drupal, Backdrop CMS, or Joomla) database username, password, server and DB name.
70 * If any of these contain a single quote or backslash, escape those characters with a backslash: \' and \\, respectively.
72 * Datasource (DSN) format:
73 * define( 'CIVICRM_UF_DSN', 'mysql://cms_db_username:cms_db_password@db_server/cms_database?new_link=true');
75 if (!defined('CIVICRM_UF_DSN') && CIVICRM_UF !== 'UnitTests') {
76 define( 'CIVICRM_UF_DSN' , 'mysql://%%CMSdbUser%%:%%CMSdbPass%%@%%CMSdbHost%%/%%CMSdbName%%?new_link=true');
82 * CiviCRM Database Settings
84 * Database URL (CIVICRM_DSN) for CiviCRM Data:
85 * Database URL format:
86 * define( 'CIVICRM_DSN', 'mysql://crm_db_username:crm_db_password@db_server/crm_database?new_link=true');
88 * Drupal and CiviCRM can share the same database, or can be installed into separate databases.
89 * Backdrop CMS and CiviCRM can also share the same database, or can be installed into separate databases.
91 * EXAMPLE: Drupal/Backdrop and CiviCRM running in the same database...
92 * DB Name = cms, DB User = cms
93 * define( 'CIVICRM_DSN' , 'mysql://cms:YOUR_PASSWORD@localhost/cms?new_link=true');
95 * EXAMPLE: Drupal/Backdrop and CiviCRM running in separate databases...
96 * CMS DB Name = cms, DB User = cms
97 * CiviCRM DB Name = civicrm, CiviCRM DB User = civicrm
98 * define( 'CIVICRM_DSN' , 'mysql://civicrm:YOUR_PASSWORD@localhost/civicrm?new_link=true');
100 * If your username, password, server or DB name contain a single quote or backslash, escape those characters
101 * with a backslash: \' and \\, respectively.
104 if (!defined('CIVICRM_DSN')) {
105 if (CIVICRM_UF === 'UnitTests' && isset($GLOBALS['_CV']['TEST_DB_DSN'])) {
106 define('CIVICRM_DSN', $GLOBALS['_CV']['TEST_DB_DSN']);
109 define('CIVICRM_DSN', 'mysql://%%dbUser%%:%%dbPass%%@%%dbHost%%/%%dbName%%?new_link=true');
115 * Used to determine if you want CiviCRM to automatically change the dsn to mysqli if its avaliable.
116 * Uncomment and edit below as necessary
118 // define ('DB_DSN_MODE', 'auto');
122 * CiviCRM Logging Database
124 * Used to point to a different database to use for logging (if desired). If unset defaults to equal CIVICRM_DSN.
125 * The CIVICRM_DSN user needs to have the rights to modify the below database schema and be able to write to it.
127 if (!defined('CIVICRM_LOGGING_DSN')) {
128 define('CIVICRM_LOGGING_DSN', CIVICRM_DSN);
134 * $civicrm_root is the file system path on your server where the civicrm
135 * code is installed. Use an ABSOLUTE path (not a RELATIVE path) for this setting.
137 * CIVICRM_TEMPLATE_COMPILEDIR is the file system path where compiled templates are stored.
138 * These sub-directories and files are temporary caches and will be recreated automatically
141 * IMPORTANT: The COMPILEDIR directory must exist,
142 * and your web server must have read/write access to these directories.
146 * If the path to the Drupal home directory is /var/www/htdocs/drupal
147 * the $civicrm_root setting would be:
148 * $civicrm_root = '/var/www/htdocs/drupal/sites/all/modules/civicrm/';
150 * the CIVICRM_TEMPLATE_COMPILEDIR would be:
151 * define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/var/www/htdocs/drupal/sites/default/files/civicrm/templates_c/');
153 * EXAMPLE - Backdrop CMS:
154 * If the path to the Backdrop home directory is /var/www/htdocs/backdrop
155 * the $civicrm_root setting would be:
156 * $civicrm_root = '/var/www/htdocs/backdrop/modules/civicrm/';
158 * the CIVICRM_TEMPLATE_COMPILEDIR would be:
159 * define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/var/www/htdocs/backdrop/files/civicrm/templates_c/');
161 * EXAMPLE - Joomla Installations:
162 * If the path to the Joomla home directory is /var/www/htdocs/joomla
163 * the $civicrm_root setting would be:
164 * $civicrm_root = '/var/www/htdocs/joomla/administrator/components/com_civicrm/civicrm/';
166 * the CIVICRM_TEMPLATE_COMPILEDIR would be:
167 * define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/var/www/htdocs/joomla/media/civicrm/templates_c/');
169 * EXAMPLE - WordPress Installations:
170 * If the path to the WordPress home directory is /var/www/htdocs/wordpress and the path to the plugin directory is /var/www/htdocs/wordpress/wp-content/plugins
171 * the $civicrm_root setting would be:
172 * $civicrm_root = '/var/www/htdocs/wordpress/wp-content/plugins/civicrm/civicrm/';
174 * the CIVICRM_TEMPLATE_COMPILEDIR would be:
175 * define( 'CIVICRM_TEMPLATE_COMPILEDIR', '/var/www/htdocs/wordpress/wp-content/uploads/civicrm/templates_c/');
179 global $civicrm_root;
181 $civicrm_root = '%%crmRoot%%';
182 if (!defined('CIVICRM_TEMPLATE_COMPILEDIR')) {
183 define( 'CIVICRM_TEMPLATE_COMPILEDIR', '%%templateCompileDir%%');
189 * This section defines absolute and relative URLs to access the host CMS (Backdrop, Drupal, or Joomla) resources.
191 * IMPORTANT: Trailing slashes should be used on all URL settings.
194 * EXAMPLE - Drupal Installations:
195 * If your site's home url is http://www.example.com/drupal/
196 * these variables would be set as below. Modify as needed for your install.
198 * CIVICRM_UF_BASEURL - home URL for your site:
199 * define( 'CIVICRM_UF_BASEURL' , 'http://www.example.com/drupal/');
201 * EXAMPLE - Backdrop CMS Installations:
202 * If your site's home url is http://www.example.com/backdrop/
203 * these variables would be set as below. Modify as needed for your install.
205 * CIVICRM_UF_BASEURL - home URL for your site:
206 * define( 'CIVICRM_UF_BASEURL' , 'http://www.example.com/backdrop/');
208 * EXAMPLE - Joomla Installations:
209 * If your site's home url is http://www.example.com/joomla/
211 * CIVICRM_UF_BASEURL - home URL for your site:
212 * Administration site:
213 * define( 'CIVICRM_UF_BASEURL' , 'http://www.example.com/joomla/administrator/');
215 * define( 'CIVICRM_UF_BASEURL' , 'http://www.example.com/joomla/');
218 if (!defined('CIVICRM_UF_BASEURL')) {
219 define( 'CIVICRM_UF_BASEURL' , '%%baseURL%%');
223 * Define any CiviCRM Settings Overrides per http://wiki.civicrm.org/confluence/display/CRMDOC/Override+CiviCRM+Settings
225 * Uncomment and edit the below as appropriate.
228 // Override the Temporary Files directory.
229 // $civicrm_setting['Directory Preferences']['uploadDir'] = '/path/to/upload-dir' ;
231 // Override the custom files upload directory.
232 // $civicrm_setting['Directory Preferences']['customFileUploadDir'] = '/path/to/custom-dir';
234 // Override the images directory.
235 // $civicrm_setting['Directory Preferences']['imageUploadDir'] = '/path/to/image-upload-dir' ;
237 // Override the custom templates directory.
238 // $civicrm_setting['Directory Preferences']['customTemplateDir'] = '/path/to/template-dir';
240 // Override the Custom php path directory.
241 // $civicrm_setting['Directory Preferences']['customPHPPathDir'] = '/path/to/custom-php-dir';
243 // Override the extensions directory.
244 // $civicrm_setting['Directory Preferences']['extensionsDir'] = '/path/to/extensions-dir';
246 // Override the resource url
247 // $civicrm_setting['URL Preferences']['userFrameworkResourceURL'] = 'http://example.com/example-resource-url/';
249 // Override the Image Upload URL (System Settings > Resource URLs)
250 // $civicrm_setting['URL Preferences']['imageUploadURL'] = 'http://example.com/example-image-upload-url';
252 // Override the Custom CiviCRM CSS URL
253 // $civicrm_setting['URL Preferences']['customCSSURL'] = 'http://example.com/example-css-url' ;
255 // Override the extensions resource URL
256 // $civicrm_setting['URL Preferences']['extensionsURL'] = 'http://example.com/pathtoextensiondir'
258 // Disable display of Community Messages on home dashboard
259 // $civicrm_setting['CiviCRM Preferences']['communityMessagesUrl'] = false;
261 // Disable automatic download / installation of extensions
262 // $civicrm_setting['Extension Preferences']['ext_repo_url'] = false;
264 // set triggers to be managed offline per CRM-18212
265 // $civicrm_setting['CiviCRM Preferences']['logging_no_trigger_permission'] = 1;
267 // Override the CMS root path defined by cmsRootPath.
268 // define('CIVICRM_CMSDIR', '/path/to/install/root/');
270 // Opt-out of announcements by the CiviCRM core team for releases, paid services, events, etc. Separate each preferred optout category with a comma:
271 // "offers": paid service offers
272 // "asks": requests for donations or membership signup/renewal to CiviCRM
273 // "releases": major release announcements
274 // "events": announcements of local/national upcoming events
275 // $civicrm_setting['CiviCRM Preferences']['communityMessagesUrl'] = 'https://alert.civicrm.org/alert?prot=1&ver={ver}&uf={uf}&sid={sid}&lang={lang}&co={co}&optout=offers,asks';
279 * If you are using any CiviCRM script in the bin directory that
280 * requires authentication, then you also need to set this key.
281 * We recommend using a 16-32 bit alphanumeric/punctuation key.
282 * More info at http://wiki.civicrm.org/confluence/display/CRMDOC/Command-line+Script+Configuration
284 if (!defined('CIVICRM_SITE_KEY')) {
285 define( 'CIVICRM_SITE_KEY', '%%siteKey%%');
289 * Enable this constant, if you want to send your email through the smarty
290 * templating engine(allows you to do conditional and more complex logic)
293 if (!defined('CIVICRM_MAIL_SMARTY')) {
294 define( 'CIVICRM_MAIL_SMARTY', 0 );
298 * This setting logs all emails to a file. Useful for debugging any mail (or civimail) issues.
299 * Enabling this setting will not send any email, ensure this is commented out in production
300 * The CIVICRM_MAIL_LOG is a debug option which disables MTA (mail transport agent) interaction.
301 * You must disable CIVICRM_MAIL_LOG before CiviCRM will talk to your MTA.
303 // if (!defined('CIVICRM_MAIL_LOG')) {
304 // define( 'CIVICRM_MAIL_LOG', '%%templateCompileDir%%/mail.log');
308 if (!defined('CIVICRM_DOMAIN_ID')) {
309 define( 'CIVICRM_DOMAIN_ID', 1);
313 * Setting to define the environment in which this CiviCRM instance is running.
314 * Note the setting here must be value from the option group 'Environment',
315 * (see Administration > System Settings > Option Groups, Options beside Environment)
316 * which by default has three option values: 'Production', 'Staging', 'Development'.
317 * NB: defining a value for environment here prevents it from being set
320 // $civicrm_setting['domain']['environment'] = 'Production';
323 * Settings to enable external caching using a cache server. This is an
324 * advanced feature, and you should read and understand the documentation
325 * before you turn it on. We cannot store these settings in the DB since the
326 * config could potentially also be cached and we need to avoid an infinite
327 * recursion scenario.
329 * @see http://civicrm.org/node/126
333 * If you have a cache server configured and want CiviCRM to make use of it,
334 * set the following constant. You should only set this once you have your cache
335 * server up and working, because CiviCRM will not start up if your server is
336 * unavailable on the host and port that you specify. By default CiviCRM will use
337 * an in-memory array cache
339 * To use the php extension memcache use a value of 'Memcache'
340 * To use the php extension memcached use a value of 'Memcached'
341 * To use the php extension apc use a value of 'APCcache'
342 * To use the php extension redis use a value of 'Redis'
343 * To not use any caching (not recommended), use a value of 'NoCache'
346 if (!defined('CIVICRM_DB_CACHE_CLASS')) {
347 define('CIVICRM_DB_CACHE_CLASS', 'ArrayCache');
351 * Change this to the IP address of your cache server if it is not on the
352 * same machine (Unix).
354 if (!defined('CIVICRM_DB_CACHE_HOST')) {
355 define('CIVICRM_DB_CACHE_HOST', 'localhost');
359 * Change this if you are not using the standard port for your cache server.
361 * The standard port for Memcache & APCCache is 11211. For Redis it is 6379.
363 if (!defined('CIVICRM_DB_CACHE_PORT')) {
364 define('CIVICRM_DB_CACHE_PORT', 11211 );
368 * Change this if your cache server requires a password (currently only works
371 if (!defined('CIVICRM_DB_CACHE_PASSWORD')) {
372 define('CIVICRM_DB_CACHE_PASSWORD', '' );
376 * Items in cache will expire after the number of seconds specified here.
377 * Default value is 3600 (i.e., after an hour)
379 if (!defined('CIVICRM_DB_CACHE_TIMEOUT')) {
380 define('CIVICRM_DB_CACHE_TIMEOUT', 3600 );
384 * If you are sharing the same cache instance with more than one CiviCRM
385 * database, you will need to set a different value for the following argument
386 * so that each copy of CiviCRM will not interfere with other copies. If you only
387 * have one copy of CiviCRM, you may leave this set to ''. A good value for
388 * this if you have two servers might be 'server1_' for the first server, and
389 * 'server2_' for the second server.
391 if (!defined('CIVICRM_DB_CACHE_PREFIX')) {
392 define('CIVICRM_DB_CACHE_PREFIX', '');
396 * If you have multilingual site and you are using the "inherit CMS language"
397 * configuration option, but wish to, for example, use fr_CA instead of the
398 * default fr_FR (for French), set one or more of the constants below to an
399 * appropriate regional value.
401 // define('CIVICRM_LANGUAGE_MAPPING_FR', 'fr_CA');
402 // define('CIVICRM_LANGUAGE_MAPPING_EN', 'en_CA');
403 // define('CIVICRM_LANGUAGE_MAPPING_ES', 'es_MX');
404 // define('CIVICRM_LANGUAGE_MAPPING_PT', 'pt_BR');
405 // define('CIVICRM_LANGUAGE_MAPPING_ZH', 'zh_TW');
408 * Native gettext improves performance of localized CiviCRM installations
409 * significantly. However, your host must enable the locale (language).
410 * On most GNU/Linux, Unix or MacOSX systems, you may view them with
411 * the command line by typing: "locale -a".
413 * On Debian or Ubuntu, you may reconfigure locales with:
414 * # dpkg-reconfigure locales
416 * For more information:
417 * http://wiki.civicrm.org/confluence/x/YABFBQ
419 // if (!defined('CIVICRM_GETTEXT_NATIVE')) {
420 // define('CIVICRM_GETTEXT_NATIVE', 1);
424 * Configure MySQL to throw more errors when encountering unusual SQL expressions.
426 * If undefined, the value is determined automatically. For CiviCRM tarballs, it defaults
427 * to FALSE; for SVN checkouts, it defaults to TRUE.
429 // if (!defined('CIVICRM_MYSQL_STRICT')) {
430 // define('CIVICRM_MYSQL_STRICT', TRUE );
433 if (CIVICRM_UF === 'UnitTests') {
434 if (!defined('CIVICRM_CONTAINER_CACHE')) define('CIVICRM_CONTAINER_CACHE', 'auto');
435 if (!defined('CIVICRM_MYSQL_STRICT')) define('CIVICRM_MYSQL_STRICT', true);
440 * Do not change anything below this line. Keep as is
444 $include_path = '.' . PATH_SEPARATOR .
445 $civicrm_root . PATH_SEPARATOR .
446 $civicrm_root . DIRECTORY_SEPARATOR . 'packages' . PATH_SEPARATOR .
448 if ( set_include_path( $include_path ) === false ) {
449 echo "Could not set the include path<p>";
453 if (!defined('CIVICRM_CLEANURL')) {
454 if ( function_exists('variable_get') && variable_get('clean_url', '0') != '0') {
455 define('CIVICRM_CLEANURL', 1 );
458 define('CIVICRM_CLEANURL', 0);
462 // force PHP to auto-detect Mac line endings
463 ini_set('auto_detect_line_endings', '1');
465 // make sure the memory_limit is at least 64 MB
466 $memLimitString = trim(ini_get('memory_limit'));
467 $memLimitUnit = strtolower(substr($memLimitString, -1));
468 $memLimit = (int) $memLimitString;
469 switch ($memLimitUnit) {
470 case 'g': $memLimit *= 1024;
471 case 'm': $memLimit *= 1024;
472 case 'k': $memLimit *= 1024;
474 if ($memLimit >= 0 and $memLimit < 134217728) {
475 ini_set('memory_limit', '128M');
478 require_once 'CRM/Core/ClassLoader.php';
479 CRM_Core_ClassLoader::singleton()->register();