-
Notifications
You must be signed in to change notification settings - Fork 62
/
config.master.php
278 lines (227 loc) · 9.54 KB
/
config.master.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
/**
* Focus Lab, LLC Master Config
*
* This is the master config file for our ExpressionEngine sites
* The settings will contain database credentials and numerous "config overrides"
* used throughout the site. This file is used as first point of configuration
* but there are environment-specific files as well. The idea is that the environment
* config files contain config overrides that are specific to a single environment.
*
* Some config settings are used in multiple (but not all) environments. You will
* see the use of conditionals around the ENV constant in this file. This constant is
* defined in ./config/config.env.php
*
* All config files are stored in the ./config/ directory and this master file is "required"
* in system/expressionengine/config/config.php and system/expressionengine/config/database.php
*
* require $_SERVER['DOCUMENT_ROOT'] . '/../config/config.master.php';
*
* This config setup is a combination of inspiration from Matt Weinberg and Leevi Graham
* @link http://eeinsider.com/articles/multi-server-setup-for-ee-2/
* @link http://ee-garage.com/nsm-config-bootstrap
*
* @package Focus Lab Master Config
* @version 1.1.1
* @author Focus Lab, LLC <dev@focuslabllc.com>
* @see https://github.com/focuslabllc/ee-master-config
*/
// Require our environment declatation file if it hasn't
// already been loaded in index.php or admin.php
if ( ! defined('ENV'))
{
require 'config.env.php';
}
// Setup our initial arrays
$env_db = $env_config = $env_global = $master_global = array();
/**
* Database override magic
*
* If this equates to TRUE then we're in the database.php file
* We don't want these settings bothered with in our config.php file
*/
if (isset($db['expressionengine']))
{
/**
* Load our environment-specific config file
* which contains our database credentials
*
* @see config/config.local.php
* @see config/config.dev.php
* @see config/config.stage.php
* @see config/config.prod.php
*/
require 'config.' . ENV . '.php';
// Dynamically set the cache path (Shouldn't this be done by default? Who moves the cache path?)
$env_db['cachedir'] = APPPATH . 'cache/';
// Merge our database setting arrays
$db['expressionengine'] = array_merge($db['expressionengine'], $env_db);
// No need to have this variable accessible for the rest of the app
unset($env_db);
}
// End if (isset($db['expressionengine'])) {}
/**
* Config override magic
*
* If this equates to TRUE then we're in the config.php file
* We don't want these settings bothered with in our database.php file
*/
if (isset($config))
{
/**
* Dynamic path settings
*
* Make it easy to run the site in multiple environments and not have to switch up
* path settings in the database after each migration
* As inspired by Matt Weinberg: http://eeinsider.com/articles/multi-server-setup-for-ee-2/
*/
$protocol = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https://' : 'http://';
$base_url = $protocol . $_SERVER['HTTP_HOST'];
$base_path = $_SERVER['DOCUMENT_ROOT'];
$system_folder = APPPATH . '../';
$images_folder = 'images';
$images_path = $base_path . '/' . $images_folder;
$images_url = $base_url . '/' . $images_folder;
$env_config['index_page'] = '';
$env_config['site_index'] = '';
$env_config['base_url'] = $base_url . '/';
$env_config['site_url'] = $env_config['base_url'];
$env_config['cp_url'] = $env_config['base_url'] . 'admin.php';
$env_config['theme_folder_path'] = $base_path . '/themes/';
$env_config['theme_folder_url'] = $base_url . '/themes/';
$env_config['emoticon_path'] = $images_url . '/smileys/';
$env_config['emoticon_url'] = $images_url . '/smileys/';
$env_config['captcha_path'] = $images_path . '/captchas/';
$env_config['captcha_url'] = $images_url . '/captchas/';
$env_config['avatar_path'] = $images_path . '/avatars/';
$env_config['avatar_url'] = $images_url . '/avatars/';
$env_config['photo_path'] = $images_path . '/member_photos/';
$env_config['photo_url'] = $images_url . '/member_photos/';
$env_config['sig_img_path'] = $images_path . '/signature_attachments/';
$env_config['sig_img_url'] = $images_url . '/signature_attachments/';
$env_config['prv_msg_upload_path'] = $images_path . '/pm_attachments/';
// $env_config['third_party_path'] = $base_path . '/../third_party/';
/**
* Custom upload directory paths
*
* The array keys must match the ID from exp_upload_prefs
*/
// $env_config['upload_preferences'] = array(
// 1 => array(
// 'name' => 'Default Uploads',
// 'server_path' => $images_path . '/uploads/',
// 'url' => $images_url . '/uploads/'
// ),
// 2 => array(
// 'name' => 'Second Folder',
// 'server_path' => $images_path . '/another_one/',
// 'url' => $images_url . '/another_one/'
// )
// );
/**
* Template settings
*
* Working locally we want to reference our template files.
* In staging and production we do not use flat files (for ever-so-slightly better performance)
* This approach requires that we synchronize templates after each deployment of template changes
*
* For the distributed Focus Lab, LLC Master Config file this is commented out
* You can enable this "feature" by uncommenting the second 'save_tmpl_files' line
*/
$env_config['save_tmpl_files'] = 'y';
// $env_config['save_tmpl_files'] = (ENV == 'prod') ? 'n' : 'y';
$env_config['tmpl_file_basepath'] = $base_path . '/../templates';
$env_config['hidden_template_indicator'] = '_';
/**
* Debugging settings
*
* These settings are helpful to have in one place
* for debugging purposes
*/
$env_config['is_system_on'] = 'y';
$env_config['allow_extensions'] = 'y';
$env_config['email_debug'] = (ENV_DEBUG) ? 'y' : 'n' ;
// If we're not in production show the profile on the front-end but not in the CP
$env_config['show_profiler'] = ( ! ENV_DEBUG OR (isset($_GET['D']) && $_GET['D'] == 'cp')) ? 'n' : 'y' ;
// Show template debugging if we're not in production
$env_config['template_debugging'] = (ENV_DEBUG) ? 'y' : 'n' ;
/**
* Set debug to '2' if we're in dev mode, otherwise just '1'
*
* 0: no PHP/SQL errors shown
* 1: Errors shown to Super Admins
* 2: Errors shown to everyone
*/
$env_config['debug'] = (ENV_DEBUG) ? '2' : '1' ;
/**
* Tracking & Performance settings
*
* These settings may impact what happens on certain page loads
* and turning them off could help with performance in general
*/
$env_config['disable_all_tracking'] = 'y'; // If set to 'y' some of the below settings are disregarded
$env_config['enable_sql_caching'] = 'n';
$env_config['disable_tag_caching'] = 'n';
$env_config['enable_online_user_tracking'] = 'n';
$env_config['dynamic_tracking_disabling'] = '500';
$env_config['enable_hit_tracking'] = 'n';
$env_config['enable_entry_view_tracking'] = 'n';
$env_config['log_referrers'] = 'n';
$env_config['gzip_output'] = 'y'; // Set to 'n' if your host is EngineHosting
/**
* 3rd Party Add-on config items as needed
*/
/**
* Member-based settings
*/
$env_config['profile_trigger'] = rand(0,time()); // randomize the member profile trigger word because we'll never need it
/**
* Other system settings
*/
$env_config['new_version_check'] = 'n'; // no slowing my CP homepage down with this
$env_config['daylight_savings'] = ((bool) date('I')) ? 'y' : 'n'; // Autodetect DST
$env_config['use_category_name'] = 'y';
$env_config['reserved_category_word'] = 'category';
$env_config['word_separator'] = 'dash'; // dash|underscore
/**
* Load our environment-specific config file
* May contain override values from similar above settings
*
* @see config/config.local.php
* @see config/config.dev.php
* @see config/config.stage.php
* @see config/config.prod.php
*/
require $_SERVER['DOCUMENT_ROOT'] . '/../config/config.' . ENV . '.php';
/**
* Setup our template-level global variables
*
* As inspired by NSM Bootstrap Config
* @see http://ee-garage.com/nsm-config-bootstrap
*/
global $assign_to_config;
if( ! isset($assign_to_config['global_vars']))
{
$assign_to_config['global_vars'] = array();
}
// Start our array with environment variables. This gives us {global:env} and {global:env_full} tags for our templates.
$master_global = array(
'global:env' => ENV,
'global:env_full' => ENV_FULL
);
/**
* Merge arrays to form final datasets
*
* We've created our base config and global key->value stores
* We've also included the environment-specific arrays now
* Here we'll merge the arrays to create our final array dataset which
* respects "most recent data" first if any keys are duplicated
*
* This is how our environment settings are "king" over any defaults
*/
$assign_to_config['global_vars'] = array_merge($assign_to_config['global_vars'], $master_global, $env_global); // global var arrays
$config = array_merge($config, $env_config); // config setting arrays
}
// End if (isset($config)) {}
/* End of file config.master.php */
/* Location: ./config/config.master.php */