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:
| Preference | Default Value | Options | Description |
|---|---|---|---|
General Settings |
|||
| site_name | MyWebsite | None | The name of the site to be displayed at the top. Also used to generate your session key. |
| fuel_path | fuel/ | None | Path to the fuel admin from the web base directory. |
| fuel_mode | views | cms, views, auto | The option cms pulls views and variables from the database, views mode pulls views from the views folder and variables from the _variables folder. The auto option will first check the database for a page and if it doesn't exist or is not published, it will then check for a corresponding view file. |
| login_redirect | fuel/dashboard | None | The page to redirect to AFTER logging in. |
| logout_redirect | :last | None | the page to redirect to AFTER logging out. Use the special value :last to redirect to the last page you were on. |
| domain | $_SERVER['SERVER_NAME'] | None | Used for system emails. Can be overwritten by MY_fuel.php |
| from_email | 'admin@'.$config['domain'] | None | Used for system emails. |
| fuel_path | fuel/ | None | Path to the fuel admin from the web base directory. |
| allow_forgotten_password | TRUE | boolean TRUE/FALSE | Allow for login link to allow forgotten passwords. |
| max_number_archived | 5 | None | Maximum number module items to archive. |
| warn_if_modified | TRUE | boolean TRUE/FALSE | Warn if a form field has changed before leaving page. |
| max_recent_pages | 5 | None | Max number of recent pages to display. |
| saved_page_state_max | 5 | None | 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 | / | None | Provide a cookie path... different from the CI config if you need it (default is same as CI config). |
| xtra_css | None | None | 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. |
| keyboard_shortcuts |
array( 'toggle_view' => 'Ctrl+Shift+m', 'save' => 'Ctrl+Shift+s', 'view' => 'Ctrl+Shift+p' ); |
None | Keyboard shortcuts for the FUEL admin. |
| dashboards |
array('fuel', 'backup');
|
None | Dashboard modules to include on FUEL dashboard page. |
| dashboard_rss | http://www.thedaylightstudio.com/the-whiteboard/categories/fuel-cms/feed/rss | None | Dashboard rss feed to pull news FUEL news items. |
Asset settings |
|||
| fuel_assets_path | fuel/modules/{module}/assets/ | None | Paths specific to FUEL... relative to the WEB_ROOT. |
| assets_excluded_dirs |
array('js', 'css', 'cache', 'swf', 'captchas')
|
None | Excludes certain folders from being viewed. |
| assets_allow_subfolder_creation | TRUE | boolean TRUE/FALSE | Allow subfolders to be created in the assets folder if they don't exist'. |
| editable_asset_filetypes |
array( 'images' => 'jpg|jpeg|jpe|gif|png', 'pdf' => 'pdf', 'media' => 'jpg|jpeg|jpe|png|gif|mov|mp3|aiff' ); |
None | Specifies what filetype extensions can be included in the folders. |
| assets_upload_max_size | 1000 | None | Max upload files size for assets. |
| assets_upload_max_width | 1024 | None | Max width for asset images beign uploaded. |
| assets_upload_max_height | 768 | None | Max height for asset images beign uploaded. |
| fuel_javascript |
array( 'jquery/plugins/date', 'jquery/plugins/jquery.datePicker', 'jquery/plugins/jquery.fillin', 'jquery/plugins/jquery.markitup.pack', 'jquery/plugins/jquery.markitup.set', '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.min', 'jquery/plugins/jquery.hotkeys', 'jquery/plugins/jquery.cookie', 'jquery/plugins/jquery.fillin', 'jquery/plugins/jquery.selso', 'jquery/plugins/jquery-ui-1.8.4.custom.min', 'jquery/plugins/jquery.disable.text.select.pack', 'jquery/plugins/jquery.supercomboselect', 'jquery/plugins/jquery.MultiFile.pack' ); |
None | Javascript files (mostly jquery plugins) to be included other then the controller js files. |
| fuel_css | None | None | CSS other then the fuel.css file which automatically gets loaded. |
| fuel_assets_output | None | TRUE, FALSE, inline, gzip, whitespace, or combine | Allow for asset optimization. Requires that all module folders have a writable assets/cache folder. |
Security settings |
|||
| default_pwd | admin | None | Default password to alert against. |
| admin_enabled | FALSE | boolean TRUE/FALSE | Enable the FUEL admin or not? |
| num_logins_before_lock | 3 | None | The number of times someone can attempt to login before they are locked out for 1 minute. |
| seconds_to_unlock | 60 | None | The number of seconds to lock out a person upon reaching the max number failed login attempts. |
| dev_password | None | None | If you set a dev password, the site will require a password to view. |
| auto_search_views | FALSE | boolean TRUE/FALSE | 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 | TRUE | boolean TRUE/FALSE, string of "xss", "php", "template" OR "entities", OR array for multiple values of array('xss', 'php', 'template', 'entities') | 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 |
Module Settings |
|||
| modules_allowed |
array('blog', 'tools')
|
None | Specifies which modules are allowed to be used in the fuel admin. |
| nav |
// Dashboard will always be there
$config['nav']['site'] = array(
'dashboard' => lang('nav_dashboard'),
'pages' => lang('nav_pages'),
'blocks' => lang('nav_blocks'),
'navigation' => lang('nav_navigation'),
'assets' => lang('nav_assets'),
'sitevariables' => lang('nav_sitevariables')
);
// if set to auto, then it will automatically include all in MY_fuel_modules.php
$config['nav']['shop'] = array();
// blog placeholder if it exists
$config['nav']['blog'] = array();
// if set to auto, then it will automatically include all in MY_fuel_modules.php
$config['nav']['modules'] = 'AUTO';
// tools
$config['nav']['tools'] = array();
// manage
$config['nav']['manage'] = array(
'users' => lang('nav_users'),
'permissions' => lang('nav_permissions'),
'manage/cache' => lang('nav_manage/cache'),
'manage/activity' => lang('nav_manage/activity')
);
|
None | Left navigation menu. Sub key menu items include site, shop, blog, modules, tools and manage |
Fuel Router Settings |
|||
| default_home_view | home | None | The default view for home. |
| use_page_cache | 'cms' | TRUE, FALSE 'cms', 'views' | Turns on cache. |
| page_cache_ttl | 0 | None | 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 | None | The name of the group the cache is associated with (so you can just remove the group). |
| max_page_params | 0 | None | Maximum number of parameters that can be passed to the page. Used to cut down on queries to the db. |
DB Table Settings |
|||
| tables |
array( 'archives' => 'fuel_archives', 'logs' => 'fuel_logs', 'navigation' => 'fuel_navigation', 'navigation_groups' => 'fuel_navigation_groups', 'pagevars' => 'fuel_page_variables', 'pages' => 'fuel_pages', 'blocks' => 'fuel_blocks', 'permissions' => 'fuel_permissions', 'user_to_permissions' => 'fuel_user_to_permissions', 'users' => 'fuel_users' ); |
None | The FUEL specific database tables. |
Page Settings |
|||
| auto_page_navigation_group_id | 1 | None | The group to associate with the auto-created navigation item. |
| page_uri_prefix | None | None | Automatically removes the following path from the location. |