Configuring FUEL CMS
The following are the main configuration options that you can set for FUEL. They can be overwritten in the application/config/MY_fuel.php file:
Fuel Configuration
The following configuration parameters can be found in the modules/fuel/config/fuel.php configuration file. It is recommended that you copy the config file and place it in your fuel/application/config directory which will override the defaults and make it easier for future updates.
| Property | Default Value | Description |
|---|---|---|
| site_name |
'MyWebsite' |
The name of the site to be displayed at the top. Also used to generate your session key |
| fuel_path |
FUEL_FOLDER.'/' |
Path to the fuel admin from the web base directory... MUST HAVE TRAILING SLASH! |
| domain |
$_SERVER['SERVER_NAME' |
Used for system emails. Can be overwritten by MY_fuel.php |
| login_redirect |
$config['fuel_path' |
The page to redirect to AFTER logging in |
| logout_redirect |
$config['fuel_path' |
The page to redirect to AFTER logging out. . Use the special value :last to redirect to the last page you were on. |
| from_email |
'admin@'.$config['domain' |
Used for system emails |
| allow_forgotten_password |
TRUE |
Allow for login link to allow forgotten passwords |
| max_number_archived |
5 |
Archiving |
| warn_if_modified |
TRUE |
Warn if a form field has changed before leaving page |
| max_recent_pages |
5 |
Max number of recent pages to display |
| saved_page_state_max |
0 |
The maximum number of pages that page state will be saved before dumping the last one saved. This is used on the list pages in the admin to save sorting and filtering. Used to save on space needed for session. |
| fuel_cookie_path |
WEB_PATH |
Provide a cookie path... different from the CI config if you need it (default is same as CI config) |
| xtra_css |
'' |
External css file for additional styles possibly needed for 3rd party integration and customizing. Must exist in the assets/css file and not the fuel/assets/css folder |
| main_layout |
'admin_main' |
The main layout file to be used for the interface. By default, it will pull from the fuel module folder however, if an array is specified, the key will be the module and the value will be the view file. |
| keyboard_shortcuts |
array( 'toggle_view' => 'Ctrl+Shift+m', 'save' => 'Ctrl+Shift+s', 'view' => 'Ctrl+Shift+p' ) |
Keyboard shortcuts |
| dashboards |
array('fuel') |
Dashboard modules to include |
| dashboard_rss |
'http:www.getfuelcms.com/blog/feed/rss' |
Dashboard rss |
| text_editor |
'markitup' |
for more editor settings, look at the config/editors.php configuration file |
| attach |
array() |
An associative array of objects to attach to the fuel object |
| languages |
array( 'english' => 'English' ) |
Languages for pages. The key is saved to the page variables |
| language_mode |
'domain' |
Specifies the method in which to look for pages with different languages. Values can be "domain", "segment", "query_string" or "both" (which means both "segment" and "query_string") |
| add_language_to_site_url |
FALSE |
Append the current language value to the site URL automatically |
| language_force_default_to_site_url |
FALSE |
force the default language segment, or query string on any URLs created with site_url |
| language_query_str_param |
'lang' |
The name of the query string parameter to use for setting the language |
| language_cookie_name |
'' |
The name of the cookie to hold the currently selected language. One will be generated if left blank |
| language_cookie_exp |
'63072000' |
Default is 2 years |
| language_use_cookies |
TRUE |
Use cookies to remember a selected language |
| language_detect_user_agent |
'' |
Will check the user agent during language detection |
| language_default_option |
NULL |
The default language to use |
| fuel_assets_path |
'fuel/modules/{module}/assets/' |
Paths specific to FUEL... relative to the WEB_ROOT |
| assets_excluded_dirs |
array('js', 'css', 'cache', 'swf', 'captchas') |
Excludes certain folders from being viewed |
| assets_allow_subfolder_creation |
TRUE |
Allow subfolders to be created in the assets folder if they don't exist' |
| editable_asset_filetypes |
array( 'images' => 'jpg|jpeg|jpe|gif|png|zip|svg', 'pdf' => 'pdf|zip', 'media' => 'mov|mp3|aiff|mpeg|zip', 'assets' => 'jpg|jpeg|jpe|png|gif|mov|mpeg|mp3|wav|aiff|pdf|css|zip|svg' ) |
Specifies what filetype extensions can be included in the folders |
| assets_upload_max_size |
'1000' |
Max upload files size for assets |
| assets_upload_max_width |
'1024' |
Max width for asset images being uploaded |
| assets_upload_max_height |
'768' |
Max height for asset images being uploaded |
| fuel_javascript |
array( 'fuel' => array( 'jquery/plugins/jquery-ui-1.8.17.custom.min', 'jquery/plugins/jquery.easing', 'jquery/plugins/jquery.bgiframe', 'jquery/plugins/jquery.tooltip', 'jquery/plugins/jquery.scrollTo-min', 'jquery/plugins/jqModal', 'jquery/plugins/jquery.checksave', 'jquery/plugins/jquery.form', 'jquery/plugins/jquery.treeview', 'jquery/plugins/jquery.serialize', 'jquery/plugins/jquery.cookie', 'jquery/plugins/jquery.supercookie', 'jquery/plugins/jquery.hotkeys', 'jquery/plugins/jquery.cookie', 'jquery/plugins/jquery.simpletab.js', 'jquery/plugins/jquery.tablednd.js', 'jquery/plugins/jquery.placeholder', 'jquery/plugins/jquery.selso', 'jquery/plugins/jquery.disable.text.select.pack', 'jquery/plugins/jquery.supercomboselect', 'jquery/plugins/jquery.MultiFile', 'fuel/linked_field_formatters', 'jquery/plugins/jquery.numeric', 'jquery/plugins/jquery.repeatable', NASTY Chrome JS bug... http:stackoverflow.com/questions/10314992/chrome-sometimes-calls-incorrect-constructor http:stackoverflow.com/questions/10251272/what-could-cause-this-randomly-appearing-error-inside-jquery-itself 'jquery/plugins/chrome_pushstack_fix.js', 'jqx/plugins/util.js', 'fuel/global') 'fuel' => 'fuel/fuel.min' ) |
Javascript files (mostly jquery plugins) to be included other then the controller js files |
| fuel_css |
array() |
CSS other then the fuel.css file which automatically gets loaded |
| fuel_assets_output |
FALSE |
Allow for asset optimization. Requires that all module folders have a writable assets/cache folder Values can be TRUE, FALSE, inline, gzip, whitespace, or combine. See the config/asset.php file for more info |
| set_upload_file_perms |
FALSE |
Set this value to the file permission that will be applied with chmod() after a file gets uploaded Value should be a unix file permission integer (i.e. 0755) |
| offline |
FALSE |
Sets the site to offline mode. Uses "offline" view file to render page |
| password_min_length |
NULL |
Sets the site password min length. An empty (e.g. NULL/0) value will not require a minimum length |
| password_max_length |
NULL |
Sets the site password max length. An empty (e.g. NULL/0) value will not require a maximum length |
| password_pattern_match |
NULL |
Sets specific patterns that the password must match (e.g. 'upper|lower|numbers|symbols') |
| offline_allowed_uri |
array('UAT') |
List of uri allowed to access when site switched to offline mode. Eg.: To allow "www.example.com/UAT" |
| restrict_to_remote_ip |
array() |
Restrict fuel to only certain ip addresses (can be string or an array of IP addresses) |
| webhook_remote_ip |
array() |
Restrict fuel webhooks like the migrate functionality to only certain IP address (can be string or an array of IP addresses) |
| default_pwd |
'admin' |
Sefault password to alert against |
| admin_enabled |
FALSE |
Enable the FUEL admin or not? |
| num_logins_before_lock |
3 |
The number of times someone can attempt to login before they are locked out for 1 minute |
| seconds_to_unlock |
60 |
The number of seconds to lock out a person upon reaching the max number failed login attempts |
| dev_password |
'' |
If you set a dev password, the site will require a password to view |
| auto_search_views |
FALSE |
Will auto search view files. The max_page_params config can also be used for this as well If the URI is about/history and the about/history view does not exist but about does, it will render the about page |
| module_sanitize_funcs |
array( 'xss' => 'xss_clean', 'php' => 'encode_php_tags', 'template' => 'php_to_template_syntax', 'entities' => 'htmlentities' ) |
Functions that can be used for the sanitize_input value on a basic module. The key of the array is what should be used when configuring your module |
| modules_allowed |
array() |
Specifies which modules are allowed to be used in the FUEL admin (e.g. 'user_guide', 'blog', 'backup'...) |
| [nav][site] |
array(
'dashboard' => lang('module_dashboard'),
'pages' => lang('module_pages'),
'blocks' => lang('module_blocks'),
'navigation' => lang('module_navigation'),
'tags' => lang('module_tags'),
'categories' => lang('module_categories'),
'assets' => lang('module_assets'),
'sitevariables' => lang('module_sitevariables')
) |
Site... Dashboard will always be there |
| [nav][modules] |
array() |
My modules... if set to empty array, then it will automatically include all in MY_fuel_modules.php |
| [nav][tools] |
array() |
Tools |
| [nav][manage] |
array(
'users' => lang('module_users'),
'permissions' => lang('module_permissions'),
'manage/cache' => lang('module_manage_cache'),
'logs' => lang('module_manage_activity'),
'settings' => lang('module_manage_settings'),
) |
Manage |
| nav_auto_arrange |
TRUE |
Will auto arrange the navigation into the normal order |
| default_home_view |
'home' |
The default view for home |
| use_page_cache |
'cms' |
Turn on cache. Can be TRUE/FALSE or cms |
| page_cache_ttl |
0 |
How long to cache the page. A value of 0 means forever until the page or other modules have been updated |
| page_cache_group |
'pages' |
The name of the group the cache is associated with (so you can just remove the group) |
| max_page_params |
array('about/news/' => 1) |
Maximum number of paramters that can be passed to the page. Used to cut down on queries to the db. If it is an array, then it will loop through the array using the keys to match against a regular expression: |
| uri_view_overwrites |
array() |
A list of URI paths that will always pull from the view folder... can use :any, like routes good to use if you are passing page parameters to your pages controlled in the admin and you have a page you always want to pull from a view file (e.g. URI = company/press and you have a page of "company" in the admin with max page params set to 1 or more it would normally pull the company page if no company/press page existed in the admin and in this case we want to pull the view file of company/press) |
| tables |
array( 'fuel_archives' => 'fuel_archives', 'fuel_blocks' => 'fuel_blocks', 'fuel_categories' => 'fuel_categories', 'fuel_logs' => 'fuel_logs', 'fuel_navigation' => 'fuel_navigation', 'fuel_navigation_groups' => 'fuel_navigation_groups', 'fuel_pages' => 'fuel_pages', 'fuel_pagevars' => 'fuel_page_variables', 'fuel_permissions' => 'fuel_permissions', 'fuel_relationships' => 'fuel_relationships', 'fuel_settings' => 'fuel_settings', 'fuel_tags' => 'fuel_tags', 'fuel_users' => 'fuel_users' ) |
The FUEL specific database tables |
| auto_page_navigation_group_id |
1 |
The group to associate with the auto-created navigation item |
| page_uri_prefix |
'' |
Automatically removes the following path from the location |
| view_in_new_window |
TRUE |
View the page from the admin in a new window or within a modal window |
| parser_engine |
'dwoo' |
The parsing engine to use for FUEL. Options are dwoo, ci and now 'twig'! |
| double_parse |
FALSE |
Runs the parsing process twice for pages created in the CMS which allows for variables to be set from within blocks and layout fields and can bubble up to the layout view file (takes slightly longer to render if caching is turned off). Valid values are TRUE, FALSE, or 'AUTO' which will be activated if fuel_set_var is called from within a block or page layout variable. This can also be set as a property of a layout object |
| parser_compile_dir |
APPPATH.'cache/dwoo/compiled/' |
The directory to put the parsed compiled files |
| parser_compile_dir_perms |
DIR_WRITE_MODE |
The folder permissions to put the parsed compiled files |
| parser_compile_file_perms |
FILE_WRITE_MODE |
The file permissions for the parsed compiled files (Dwoo only) |
| parser_delimiters |
array(
'tag_comment' => array('{#', '#}'), Twig only
'tag_block' => array('{%', '%}'), Twig only
'tag_variable' => array('{', '}'), Used by Twig, Dwoo and CI. Default for twig is '{{', '}}'
'interpolation' => array('#{', '}'), Twig only
) |
The delimiters used by the parsing engine |
| parser_allowed_functions |
array( 'strip_tags', 'date', 'detect_lang','lang', 'js', 'css', 'swf', 'img_path', 'css_path', 'js_path', 'swf_path', 'pdf_path', 'media_path', 'cache_path', 'captcha_path', 'assets_path', 'docs_path', assets specific 'fuel_block', 'fuel_model', 'fuel_nav', 'fuel_edit', 'fuel_set_var', 'fuel_var', 'fuel_var_append', 'fuel_form', 'fuel_page', FUEL specific 'quote', 'safe_mailto', HTML/URL specific 'session_flashdata', 'session_userdata', Session specific 'prep_url', 'site_url', 'show_404', 'redirect', 'uri_segment', 'auto_typography', 'current_url' CI specific ) |
Functions allowed by the parsing engine |
| parser_refs |
array('config', 'load', 'session', 'uri', 'input', 'user_agent') |
Object references passed to the parsing engine |
| generate |
array(
'search' => array('app', 'fuel'),
'advanced' => array(
'assets/css/{module}.css',
'assets/images/ico_cog.png',
'assets/js/{ModuleName}Controller.js',
'assets/cache/',
'config/{module}.php',
'config/{module}_constants.php',
'config/{module}_routes.php',
'controllers/{Module}_module.php',
'helpers/{module}_helper.php',
'install/install.php',
'libraries/Fuel_{module}.php',
'language/english/{module}_lang.php',
'models/',
'tests/sql/',
'views/_admin/{module}.php',
'views/_blocks/',
'views/_docs/index.php',
'views/_layouts/',
),
'simple' => 'MY_fuel_modules.php',
'model' => array(
'{Model_name}_model.php',
'sql/{table}.sql',
)
) |
The files/folders to generate with the CLI generate command |