glFusion Wiki

Site Tools


glfusion:configuration:siteconfig

siteconfig.php

The siteconfig.php file is located in the web root of your site. This file contains advanced configuration options that generally do not need to change. There may be occasions where you need to tweak the default behavior of glFusion to meet your environment's needs or personal tastes.

To modify the settings in siteconfig.php, you will need to manually edit the file, make your changes and then save on your web site.

The following options are available in siteconfig.php

use_direct_style_js
Directly call the style / JS cache files. If loading the PHP processor on your site adds additional load to your web server, you can skip that process and load the cache files directly from the htmlheader.thtml template.
html_filter
Select which HTML filtering engine to use - HTMLPurifier provides stricter filtering and HTML compliance, but it also requires a site be running with pure UTF-8 content. If there is an issue, htmlawed is another excellent filter, but it does not enforce strict HTML compliance as well.
site_enabled
A glFusion site can be disabled quickly (e.g. for maintenance) by setting this to 'false'. Also see the site_disabled_msg configuration option.
maintenance_mode
Depreciated - Please use the online configuration utility setting Enable Maintenance Mode

Allows the site admin to disable the site for non-admin (and anonymous) users.

This mode is useful if you have maintenance work to do like installing a new plugin or reorganizing content. You must login to your site as an admin user before enabling this option since it will disable all non-admin users.

glfusion:configuration:miscellaneous#debug

rootdebug
Depreciated - Please use the online configuration utility setting Root Debug

Display detailed error messages. This option can be useful in diagnosing errors on your site.
This option should not be enabled on production sites since it will display configuration data and other details that could expose confidential data such as database logins, etc.
rootdebug is very helpful when diagnosing errors on your web site. Since rootdebug will provide more verbose error messages, it can be useful to enable this for short periods of time when diagnosing an issue.
debug_oauth
Depreciated - Please use the online configuration utility setting Debug OAuth

Display detailed message from Oauth authentication. If this is set to true - verbose log messages of the Oauth login process will be logged to the glFusion error.log file. This option is useful if you are experiencing issues with any of the Oauth protocols.
debug_html_filter
Depreciated - Please use the online configuration utility setting HTML Filter Debug

If this is set to true - the HTML filter will log details on which HTML elements and attributes are filtered.
no_fail_sql
If your site becomes unavailable due to the 'An Error has Occurred' message, many times it may be a problem with an upgrade or new plugin accessing the database. Set this variable to True to ensure that database errors do not stop your site from working. This can be very helpful in diagnosing the database errors.
no_cache_config
Disable configuration caching. If you experience issues with the caching of the configuration options you can disable the caching feature by setting this value to true.
disable_instance_caching
If you experience issues with the instance cache files you can disable the caching feature by setting this to true.
admin_session
The number of seconds the administrative session will be valid. Set this to 0 to disable admin access re-authentication.
token_ttl
The number of seconds that the standard security token is valid. The default is 20 minutes (1200 seconds)
verification_token_ttl
The number of seconds that the registration verification token is valid. The default is 24 hours (86400 seconds).
token_ip
Use IP address to validate tokens instead of referring URL. By default, glFusion will use the referrer URL to validate security tokens. In some cases, the browser may not send this data, so you can use the remote IP as the check. If this value is set to true, the IP address will be checked instead of the referring URL.
max_captcha_attempts
If automatic banning is enabled in the Bad Behavior 2 configuration, this is the maximum number of attempts to pass the CAPTCHA before the user receives a temporary ban.
custom_topic_templates
If set to true - glFusion will look in the custom/ directory for custom story templates by topic (i.e.; storytext_TOPICID.thtml)
alert_timeout
The number of milliseconds to display the informational alerts.
alert_position
Specifies where the information alert is displayed - valid values are:
  • 'top-center'
  • 'top-left'
  • 'top-right'
  • 'bottom-center'
  • 'bottom-left;
  • 'bottom-right'
style_type
Specifies the base uikit style - valid values are:
  • '.' - will use the flat style (this is a period enclosed in single quotes)
  • '.gradient.' - will use the gradient style
  • '.almost-flat.' - will use the almost flat style
See UIKIT Styles in Custom Themes for more information.
db_backup_rows
Defines the maximum number of rows to process in one iteration. You may want to lower the default value of 10,000 to a lower number if you are experiencing timeouts when doing database backups.
sp_pages_in_plugin_menu
If the Add to Menu option is checked on a static page, that page will be included on a menu of type 'Static Page Menu'. If you also want the page to display on the menu type of 'Plugins' (which was the default behavior at one time), set this value to true. NOTE You must clear the system cache after changing this value.
css_cache_filename
When running multiple sites off the same code base, having the ability to define unique cache files per site can be beneficial. You normally do not need to adjust this setting.
js_cache_filename
When running multiple sites off the same code base, having the ability to define unique cache files per site can be beneficial. You normally do not need to adjust this setting.
path
Base file system path for your site (trailing slash necessary)
path_system
Path to your system directory for your site (trailing slash necessary). This directory holds the code libraries used throughout glFusion
default_charset
Character encoding used by glFusion when serving HTML pages or sending email. Only used if the language file did not already set another character encoding. For multi-language setups, using 'utf-8' as the default character set is recommended.
db_charset
The character set of the database connection. Generally this should be 'utf8'
glfusion/configuration/siteconfig.txt · Last modified: 2017/04/12 21:11 (external edit)

Page Tools