glFusion Documentation Project glFusion Wiki

# glFusion Configuration

Almost all of glFusion’s configuration options can be controlled via the online Configuration Manager which is located under the Admins Only menu labeled Configuration. The Configuration Manager is separated into logical sections.

# Site

The Site Configuration section controls items such as the site URL, how URLs are written, etc. Generally these options should not change often.

## Site

Site URL | Base URL for your site (no trailing slash)
Admin URL | Base URL of the admin area of your site (no trailing slash). You won't have to change this normally, but some hosting services use a predefined “admin” directory for other purposes. In this case, you can rename glFusion's admin directory and adjust the URL accordingly to avoid conflicts.
Site Name | Name of your site
Slogan | Slogan for your site. This is added to the HTML title field.
Microsummary | No documented definition at this time.
Site Disabled Message or URL | This contains the message to display when a glFusion site is disabled. If the text begins with “http:” then visitors are redirected to that URL.
Enable Maintenance Mode | Setting this to TRUE will block all non-admin users from using the site. All non-admin users will see the Site Disabled Message or URL. Admin users will still be able to access all features of the site. This is useful when you need to perform maintenance on the site and do not want any users to access during the maintenance. You must login as an admin user before setting this to true!
Copyright Year | Set this to the year you want to appear in the copyright notice of your site's footer. If not set, glFusion will use the current year.
Enable URL Rewrite | glFusion includes a simple but useful URL rewriting feature which can help make your site more crawler friendly (i.e. the URLs of your site are more likely to be picked up by the search engine's indexing bots). This feature is supported for URLs to stories, static pages, the article directory, and links. URL rewriting means that the URLs will look like this http://www.glfusion.org/article.php/20021022234959146 Instead of this http://www.glfusion.org/article.php?story=20021022234959146 While some search engines will pick up the second form, Google seems to prefer the first format and completely ignores the second format. This feature may not work with all web servers. It is known to work with Apache (all versions) and known not to work with IIS (at least some versions). Please try it out before you go public with your site.

## Mail

Site E-Mail | E-mail address for all admin mail
No-Reply E-Mail | This is the sender's address of emails sent by the system when users register etc. This should be either the same as Site E-Mail or a bouncing address to prevent spammers from getting your email address by registering on the site. If this is not the same as Site E-mail, there will be a text in the system messages that replying to this message is not recommended since no one will receive the reply.
Mail Backend | Select which email backend to use: Mail - Use PHP's internal email Sendmail - Call sendmail directly SMTP - Send email out via SMTP to external mail server.
Path to Sendmail | If you chose 'sendmail' for the backend setting, this specifies the complete path to the sendmail executable.
Sendmail Parameters | If you chose 'sendmail' for the backend setting, this variable can be used to pass additional parameters to the sendmail binary.
SMTP Host Name | If you chose 'SMTP' as the mail backend - Place the fully qualified domain name of your SMTP server.
SMTP Port | If you chose 'SMTP' for the backend setting, this is the port number to talk to on the SMTP server. The default value is port 25.
Require SMTP Auth | If you chose 'smtp' for the backend setting, set this to true if your SMTP server requires authorization, and false if it doesn't.
SMTP Auth Username | If you chose 'smtp' for the backend setting, this is the name of your SMTP account.
SMTP Auth Password | If you chose 'smtp' for the backend setting, this is the password for your SMTP account.
SMTP Security Protocol | If your SMTP server requires a secure connection, select the protocol.
Force email from address to be site email | Force the From address to be your site email address. This is useful for hosting providers that do not allow email from addresses that are not from your domain. This will force the Reply-To address to be the email address of the user.

## Syndication

glFusion can export its headlines to a news feed in various formats (RSS, RDF, and Atom). This will let you share your news with other sites (Hint: Create a Portal block from glFusion's Block menu to import news feeds from other sites).

Enable Feeds | Create a feed file for the stories in rdf_file.
Syndication Output Folder | File system path for the feed file. This file allows you to share your site's headlines with others.
Feed Limit | Limit the number of stories to export to the news feed. If the value for this setting is a number, the feed will hold this many stories. If the number is followed by a lower-case 'h' (e.g. 24h) it denotes the number of hours from which to choose the stories.
Length of Stories in Feed | If this value is 1, then the entire introtext of the stories will be included in the news feed. Any number greater than 1 limits the introtext to that many characters (e.g. a value of 80 would only include the first 80 characters from the introtext in the feed). If set to 0, the introtext is not included in the feed.
Feed Language | Value for the feed's language tag. Depending on your site's language and operating system, this may differ from the language setting in the locale (see above). Example: The PHP locale setting for German is 'de_DE' while the correct language setting for a German RSS feed would be 'de-DE' (note the dash instead of the underscore).
Maximum Number of Headers (portal blocks) | Upper limit for the max. number of headlines when importing a feed (into a portal block). The limit can also be set for each individual portal block in the block menu. When set to 0, all headlines are imported.

## Paths

HTML Path | Path to your web tree directory for your site (trailing slash necessary). This directory holds all the web pages used by glFusion.
Log | File system path for the log files
Language | location of the glFusion language files
Backup | location where mysqldump (see above) will store database backups
Data | File system path for the data directory, used e.g. for the user batch add feature
Images | Path where glFusion expects to find its images, including user photos and images for stories.

## Pear

Have Pear | Whether you have PEAR installed on your server (= true) or not (= false). When set to false, glFusion will use the PEAR packages installed in $_CONF['path_pear'] (see below)
Path Pear | When $_CONF['have_pear'] (see above) is set to false, this is the path where glFusion expects to find the PEAR packages it requires (e.g. PEAR::Mail for sending emails).

## MySQL

Allow MySQL Dump | Enable or disable the backup functionality (1 = on, 0 = off). (only used when running on a MySQL database)
Path of Executable | Complete path to the mysqldump utility (part of MySQL) for making backups of your glFusion database. (only used when running on a MySQL database)
MySQL Dump Options | Here you can include additional options for the mysqldump call that glFusion uses to create a backup from your database. (only used when running on a MySQL database)

## Search

Results List Style | Defines the format of the search results page: Google Style - Presents the results in a Google Style format Table Style - Presents the results in a tablular format.
Page Limits | Defined the valid page options for the Number of items per page dropdown on the search results page.
Number of Search Results | Default number of search results per page.
Show Result Number | Whether or not to display the number of each search result.
Show Result Type | Show the result type (i.e. Forum, Wiki, Story, etc.)
Show Author | Show the Author of the search item.
Show Number of Hits | Show the number of hits / views of the search item.
If No Data is Available, Display | If no data description is available, display this text.
Group Separator | Separator between groups.
Default Search Method | Default Search Method: - all of the words - any of the words - exact phrase

# Stories and Trackback

## Story

Max Images per Article | Maximum number of images you can have in a story.
Stories per Page | Number of stories to limit the index page to, this same number will appear in the older stuff block.
Minimum Stories per Page | Minimum numbers of stories than can appear on a topic page
Show “Contributed By” | Show author username to public, and enable search by username (0=no, 1=yes)
Hide Story Date | If True, the publish date for the story will appear in the story header. If False, the date will not be displayed.
Hide Views Count | Whether to show (= 0) or to hide (= 1) the number of views a story has had.
Hide E-mail Icon | When set to 1, this will disable the ability to send a story by email. It will also hide the email icon from stories and the “Email Article To a Friend” from the Story Options block.
Show Digg.com Links | If set to true, this will add a small Submit Story to Digg icon next to the Email and Print icons at the top of the story.
Hide Print Icon | When set to 1, this will disable display of a story in a “printer friendly” format. It will also hide the printer icon from stories and the “View Printable Version” from the Story Options block.
Enable Story Rating | Allow users to rate stories on the site. Valid options are Diabled - no rating Logged-In User - allow all Logged-in Users to rate stories Everyone - Allow any site visitor to rate stories
Allow Page Breaks | Allow usage of the [page_break] tag in stories (when set to 1), so that stories can spread over multiple pages.
Comments on Multi-page Articles | When the [page_break] tag is allowed in stories (see above), where should the story's comments be displayed: 'last' = on the story's last page only, 'first' = on the first page only, 'all' = on every page.
Topic Icon Alignment | Which side of article the topic image should be shown (right or left)
Show Topic Icon | Default setting for new stories and story submissions: Whether to show the topic icon (1) or not (0).
Draft Flag Default | Default setting for new stories created by Story Admins: Whether the story's draft flag should be set (1) or not (0).
Frontpage Default | Default setting for new stories and story submissions: Whether the story should appear on the site's frontpage (1) or only in its topic's page (0). Please note that for stories submitted to the archive topic, this setting will be ignored and the story will not appear on the frontpage.
Hide “No News” Message | When set to 1, hide the “No News To Display” message on the index page (e.g. when viewing a topic without any stories in it)
Hide Main Page Navigation | When set to 1, this option will hide the “Google paging” navigation from index.php, i.e. from the site's frontpage and all topic pages. This may come in handy for more advanced layouts but will of course prevent people from easily reaching older articles.
Only Root can Feature | When set to 1, this will only allow members of the Root group to make a story “featured”, i.e. the sticky top story on the site.
After Saving Story | Page to land on after saving a story.

## Trackback

Trackback Enabled | Enable (True) or disable (False) trackback comments. This applies to both sending and receiving trackback comments.
Trackback Default | Default value for new stories: Trackback enabled (True) or disabled (False).
Trackback Speed Limit | Number of seconds between two trackbacks / pingbacks from the same IP address.
Check Trackbacks | This option can be used to check the validity of a trackback. You can check if the URL in the trackback actually contains a link back to your site (otherwise, it's probably spam). You can also check if the trackback was sent from the proper IP address, (i.e. the IP of the site in the trackback URL. Again, if they don't match, it's probably spam). Note that you can add up the values below to do more than one check (but using option 1 and 2 doesn't make sense and will be treated as if you requested option 2). Options are: * Check against Site URL * Check against Site URL and full URL * Check full URL * Check IP against Site IP * Check IP and Full URL * Check IP and Site URL * Check IP, Full URL and Site URL * Don’t Check Anything
Multiple Trackbacks | How to handle multiple trackbacks and pingbacks from the same source. Options are: * Allow multiple posts * Only keep latest (overwrite previous entries from this site) * Reject

## Pingback

Pingback Enabled | Enable (True) or disable (False) pingback support. This applies to both sending and receiving pingbacks.
Create Pingback Excerpt | Unlike Trackbacks, Pingback don't include an excerpt of the text from the site linking to us. When this option is enabled, glFusion will try and create an excerpt by searching the backlink on the site that sent the Pingback, extract a piece of the text near the link, and use that as the excerpt for the Pingback.
Pingback Self | Pingbacks are sent out automatically to all the URLs linked from a story - which includes stories on your own site that you may have linked in the article. This option lets you specify how these “self pingbacks” are to be handled: Skip them, (i.e. don't send pingbacks to stories on your own site). Allow them, but obey the speed limit. Allow them and ignore the speed limit. If your article contains more than one link to other stories on your site, then option 2 is probably of limited use, as it would only pingback the first linked story and run into the speed limit for the others.
Ping Enabled | Enable (True) or disable (False) the ability to ping weblog directory services like Technorati.

# Theme

Theme | Default theme to use on the site
Menu Elements | Specifies which entries are displayed in the site's menu bar (if your theme uses the {menu_elements} variable to display the menu bar). Can be any combination of 'home', 'contribute', 'calendar', 'search', 'directory', 'prefs', 'plugins', and 'custom' where 'plugins' is the same as the {plg_menu_elements} variable, i.e. a list of the menu entries provided by plugins, and 'custom' displays the entries returned by a custom function CUSTOM_menuEntries (see lib-custom.php for details).
Themes Path | Directory where all themes reside

## Advanced Settings

Always Show Right Blocks | If set to true, the right-side column of blocks will be displayed on all pages (instead of only on the index page).
Show First Story as Featured | When set to 1, this will render the first story on any page using the templates for a featured story, even if that story is not featured. This will even be applied to the first story on page 2 of a topic page, for example.
Compress CSS | glFusion collects all the site CSS and sends it as a single item. glFusion can perform some simple compression (remove comments, whitespace, etc.) when it sends the CSS. This can speed up the page loads, but it makes the CSS difficult to read if you view the page source.
Include Template Comments in Page Source | Each template contains some internal comments (surrounded with {# #} ) that are removed before the template is sent to the browser. If this option is set to True, the {# and #} will become <!-- --> HTML comments and will be included in the output to the browser. Also, the beginning and end of each template, along with it's physical location on the server, will be included in the output. This feature is useful if you are trying to determine which template controls a specific display item, or when developing a new theme. If this is set to False, the comments are removed prior to sending the output to the browser.

# Caching

Enable Template Caching | If this option is enabled (set to TRUE) all templates will be cached, which should improve performance of the web site. In some cases, caching could slow performance down. For example, if the disk access is slow on the web server or if the web server is accessing Windows shared drives, setting this option to FALSE may improve performance.

# Blocks

## Admin Block

Sort Links | If set to true will sort the entries in the Admin's block and the icons on the Submissions page (moderation.php) alphabetically.
Link to Documentation | Add a link to glFusion's documentation to the Admin block. Set this to 0 if you don't want that link to show up.
Link to Version Checker | Add a link “GL Version Test” to the Admin block so that you can easily check if your glFusion version is up to date. Set this to 0 if you don't want that link to show up. Note: The link is only displayed to members of the Root group anyway.
Hide Admin Menu Outside Admin Pages | When set to "True" this will disable the Admins Only block from showing unless you are on any of the Admin pages.

## Topic Blocks

Sort Topics | alpha = Sort topics in topic list alphabetically sortnum = Sort topics in topic list by sort number
Show Story Count | Show the number of stories in a topic in the Sections block (0=no, 1=yes)
Show Submission Count | Show the number of story submissions for a topic in the Sections block (0=no, 1=yes)
Hide Home Link | Hide the “Home” link from the Sections block (0=no, 1=yes)

## Who's Online Block

Session Threshold | How long, in seconds, users can be idle before removing them from the whosonline block
Hide Name from Guests | If enabled (i.e. set to 1), anonymous users will only see the number of registered users currently online in the Who's Online block but not their names. Only logged-in users will see the names of other users that are currently online.

## What's New Block

New Stories Interval | Stories are “new” if they are this many seconds old.
New Comments Interval | Comments are “new” if they are this many seconds old.
New Trackbacks Interval | Trackback comments are “new” if they are this many seconds old.
Hide New Stories | Set to 1 to hide new stories from the What's New block.
Hide New Comments | Set to 1 to hide new comments from the What's New block.
Hide New Trackbacks | Set to 1 to hide new trackback comments from the What's New block.
Hide New Plugin Entries | Set to 1 to hide new entries by plugins from the What's New block.
Title Trim Length | Max. length of the title of items listed in the What's New block.

# Users and Submissions

## Users

Disable New User Registration | When set to true completely disables all options to sign up as a new user.
Allow User Themes | If set to 1, users can set their own theme that the site uses
Allow User Language | If set to 1, users can select the language for the site navigation
Allow User Photo | If set to 1, users can upload a photo to their profile
Allow User name change | If set to 1, users will be allowed to change their username (login name). Stories and comments posted under the old username will automatically show the new username.
Allow Account Deletion | If set to 1, users will be allowed to delete their accounts. Stories and comments posted under that account will be kept and show up as being posted by “Anonymous”.
Allow Hide Author | If set to 1, the option to to exclude certain authors from being seen is hidden from the user's preferences.
Show Fullname | Whether to display a user's full name (= 1) or only their username (= 0). For users that haven't entered their full name, glFusion will always display the username.
Show Service Name | If you allow users to log in with accounts on remote services (like LDAP or LiveJournal), this option will at the service's name to the username to avoid confusion with local users of the same name. Set to false to disable.
Hide Exclude Content Tab | When set to true, glFusion will hide the Content tab in the user profile screen. This tab allows users to block certain content and content authors, but it can also cause some confusion with site users.
Enable Custom Registration | When set to true, glFusion will let you use your own signup form for new user registrations. Please see the file lib-custom.php that ships with glFusion for an example.
User Login Method [standard] | Whether to allow normal logins into the site, i.e. with a user account that only exists in your site's database.
User Login Method [openid] | Whether to allow logins using OpenID. This will display a special OpenID login below the normal login field. Note: Currently only OpenID 1.1 is supported.
User Login Method [3rdparty] | Allow (when set to true) users who already have an account with some other service to log into your glFusion site with the login for that service. Currently supported: LDAP and LiveJournal. Please note that to enable login for a specific service, you need an authorization class in system/classes/authentication. If you only want to allow LDAP but not LiveJournal users (or vice versa), simply remove the class file for the unwanted service(s). See Remote Authentication in glFusion for more information.
After SAving User | Which page to go to after a user has been saved: * 'item': display the user's profile * 'list': show admin's list of users (default) * 'home': display the site's homepage * 'admin': go to the “Admin Home” page, i.e. Command & Control

## Spam-X

Spam-X Actions | Tells glFusion's Spam-X plugin what to do when a spam post has been detected. The value is the sum of all values that uniquely identify the Spam-X modules that should be executed. E.g. the “delete” action module uses 128, the “email admin” module uses 8, so if both modules should be executed, this option should be set to 128 + 8 = 136.

## Login Settings

Record Last Login | Whether to keep track of when a user last logged in (= true) or not (= false).
Login Required | Login is required to access any part of the site. When set to 1, this overrides the following settings. When you only want to block access to certain parts of the site, set this to 0 and select from the following settings.
Submit Login Required | When set to 1, only registered users can submit stories and items handled by plugins, e.g. links and events
Comment Login Required | When set to 1, only registered users can submit comments
Stats Login Required | When set to 1, only registered users can access the site stats
Search Login Required | When set to 1, only registered users can use the advanced search. When set to 2, the simple search is blocked for anonymous users, too.
Profile Login Required | When set to 1, only registered users can view another user's profile
E-mail User Login Required | When set to 1, only registered users can use the email submission form to send an email to another user
E-Mail Story Login Required | When set to 1, only registered users can email stories
Directory Login Required | When set to 1, only registered users can access the list of past articles
Pasword Speed Limit | Minimum delay between two requests for a new password, in seconds.
Max. Login Attempts | Max. number of login attempts before the speedlimit (see below) kicks in and further logins are blocked for the given amount of time.
Login Speed Limit | How many seconds have to pass before another login attempt can be made after $_CONF['login_attempts'] (see above) login attempts have failed.

## User Submission

User Submission Queue | Enable (1) or disable (0) the user submission queue (i.e. new users must be approved before they receive their password)
Registration Type | Generate Password will automatically generate a random password for the user upon registration, and send it to them in the welcome email. User Enters Password will prompt the user to create their own password when they fill out the registration form, and will require them to click on a verification link sent in the welcome email.
Automatic Allow Domains | When the user submission queue is enabled this can contain a comma-separated list of domain names from which user submissions will not be queued (but approved automatically). Regular expressions are also allowed and interpreted. Example: 'mycompany.com,myothercompany.com'
Automatic Disallow Domains | This is the opposite of $_CONF['allow_domains'] (see above): A list of domain names that are not allowed in email addresses of new users. Note that this list is always used, even when the user submission queue has been switched off. Again, regular expression can be used. Example disallow email addresses with a certain domain name and from any ”.edu” domain: 'somebaddomain.com,\.edu$'
Full Name option on registration form? | This controls whether there will be a "Full Name" field shown on the user registration form. The options are: No: The new user will not be able to enter a full name during registration. This matches the method used by Geeklog. Optional: The user will be able to enter a full name during registration, but is not required to do so. Required: The user will be required to enter a full name before submitting the registration form.

## Submission Settings

Story Submission Queue | Enable (1) or disable (0) the story submission queue
Only allow submission to topics with write permission | If false, a user can submit a story to any topic, regardless of the topic permissions (the story will go to the submission queue if enabled). If true, a user can only submit stories to a topic that they have write permissions to. If true, this will disable anonymous submissions since a non-logged-in user will never have write permissions to a topic.
List Draft Stories | When set to 1, this will display an additional block on the submissions page (moderation.php) that lists all the stories that have the 'draft' flag set.
Default Post Mode | Sets the default submission mode to 'html' or 'plaintext'
Post Speed Limit | Minimum delay between submissions in seconds. This helps prevent Denial of Service (DOS) attacks
Skip Preview in Posts | If 1, allows submission of stories and comments without previewing (i.e. the submission form will always have a Preview and a Submit button).
Advanced Editor | Enable (if set to true) a WYSIWYG editor for story and comment submissions and static pages. glFusion ships with FCKeditor.
Wikitext Editor | Allow using wiki syntax in stories. This adds a third option, “Wiki-style format”, to the Post Mode dropdown in the story editor (implemented using the PEAR::Text_Wiki package).

## Comments

Comment Speed Limit | Number of seconds between posting a comment for the user
Comment Limit | Most number of comments to show at any one time
Comment Mode | How to display comments (threaded, nested, flat or nocomments)
Comment Default | Default value for new stories: Comments enabled (0) or disabled (-1)
Allow Comment Edit | Allow users to edit their comments.
Comment Edit Time | The amount of time a user has to edit their comments (in seconds). If set ot 0, the user can edit the comment anytime in the future.
Comment Post mode | Select the default postmode for comments.
Comment Editor | Select the type of editor to use for comments. Options are Text Box which uses a standard HTML text box for both HTML and text comments. WYSIWYG will display the advanced What You See is What You Get editor.
Days to close comments | Default number of days to set the Comment Close date on new stories.
Number of most recent stories enabled for comments | If this number is greater than 0, it becomes the number of active stories to allow comments. For example, if set to 5, the 6th and older stories on your site will automatically have the comment closed setting applied.

# Images

## Image Library

Image Library | Set this to either 'imagemagick', 'netpbm', or 'gdlib' if images should be resized during upload.
Path to ImageMagick | If you chose 'imagemagick' for the Image Library above, then this should hold the full path to the convert executable (from the ImageMagick package), e.g. '/usr/bin/'. You will need a fairly recent version of ImageMagick for this to work (version 5.4.9 or newer is recommended).
Path to Netpbm | If you chose 'netpbm' for Image Library above, then this should hold the complete path to the directory where the binaries from the netpbm package are kept, e.g. '/usr/bin/netpbm/'. Note that the path must end in a slash. Precompiled binaries of the netpbm package for various platforms can be downloaded from the Homepage of the Gallery project.
Enable JHEAD | JHEAD is a command line utility that will save the EXIF/IPTC data in your images. By enabling JHEAD support, glFusion will be able to save all the EXIF/IPTC data even if it has to resize the original image, or remove the original image (EXIF/IPTC data will be saved in the display image).
Path to jhead executable | This is the absolute path on your server where the jhead binary on your server.
Enable jpegtrans | JPEGTRANS is a lossless tool for manipulating JPG images. It will allow for images to be rotated on line without loosing any quality.
Path to jpegtrans executable | This is the absolute path on your server where the jpegtrans binary on your server.

## Upload

Keep Unscaled Image | Set this to 1 if you want glFusion to keep the original, unscaled images after upload. The smaller image will then be used as a thumbnail and will link to the original image. Note that this may use a lot of disk space (depending on the size of your images).
Allow User Scaling | When unscaled images are kept (see above), this option lets the user chose between using the scaled or unscaled image in the story, i.e. enables the [unscaledX] image tag (in addition to the [imageX] tag).
JPEG Quality Factor |
Debug Image Uploading | When not commented out(!) and set to true, this option enables debugging output to be written into glFusion's error.log file during the upload of an image. This is useful to track down problems with the image upload.

## Images in Articles

Max. Image Width | Maximum width of an image in pixels. If it exceeds this, it is either rejected or resized (depending on the setting of $_CONF['image_lib'] above).
Max. Image Height | Maximum height of an image in pixels. If it exceeds this, it is either rejected or resized (depending on the setting of $_CONF['image_lib'] above).
Max. Image Size | Maximum size of an image in bytes. If it exceeds this, it is is rejected (even if you're using a graphics package to resize images).

## Topic Icons

Max Topic Icon Width | Max. width of a topic icon in pixels. If it exceeds this, it is either rejected or resized (depending on the setting of $_CONF['image_lib'] above).
Max Topic Icon Height | Max. height of a topic icon in pixels. If it exceeds this, it is either rejected or resized (depending on the setting of $_CONF['image_lib'] above).
Max Topic Icon Size | Max. size of a topic icon in bytes. If it exceeds this, it is rejected (even if you're using a graphics package to resize images).

## Photos

Max Photo Width | Max. width of a user photo in pixels. If it exceeds this, it is either rejected or resized (depending on the setting of $_CONF['image_lib'] above).
Max Photo Height | Max. height of a user photo in pixels. If it exceeds this, it is either rejected or resized (depending on the setting of $_CONF['image_lib'] above).
Max Photo Size | Max. size of a user photo in bytes. If it exceeds this, it is rejected (even if you're using a graphics package to resize images).
Force Photo Width | This option, when enabled, will only apply when displaying a user photo. The <img> tag for the user photo will be emitted with a max. width, as specified by this option. This means that the actual photo can still be larger, but will only be displayed smaller. This is useful for cases where you don't want oddly shaped user photos to break your page's layout (e.g. in a forum).
Default Photo | When enabled, this option should point to an image (full URL required!) that should be displayed for users without a user photo. When this option is not set and a user does not have a user photo (or an avatar) then glFusion will simply not display anything.

## Gravatar

User Gravatar | If enabled (set to true), a user's avatar image will be requested from gravatar.com if the user didn't upload a user photo (i.e. an uploaded photo always takes priority). Please note that this option may slow down your site on pages that display a lot of userphotos for different users (e.g. forum threads).
Gravatar Rating Allowed | Avatars submitted to gravatar.com are rated with the rating system used for movies (in the U.S.), i.e. the letters G, PG, R, or X. This option will let you chose the maximum allowed rating for an avatar. For example, a max. rating of R will make sure that no X-rated avatars will be displayed on your site (only G, PG, and R).

# Languages and Locale

## Language

Language | Name of your language file. Additional language files may be available for download at http://www.glfusion.org. If you translate a language file, please send it to us. Also see Localization below.
Language Files | For multi-lingual setups only: A list mapping language shortcuts ('en', 'de', etc.) to the glFusion language files to use.
Languages | For multi-lingual setups only: A list mapping language shortcuts ('en', 'de', etc.) to the language's native name (“English”, “Deutsch”, etc.). See language for more information.

## Locale

Locale | Locale for the system. This defines both the language and the country that PHP will use when deciding how to display localized information such as dates (e.g. for the names of months).
Date Format | Date format used for most of the site, including story displays. See date formats below.
Daytime Format | Date format used when a shorter date is needed. See date formats below.
Short Date Format | Date format this is the shortest date. See date formats below.
Date Only Format | Short date format (day and month only), to be used e.g. in the Upcoming Events and Older Stories blocks. See date formats below.
Time Only Format | Format string for the time only, to be used e.g. on the Event Details page. See date formats below.
Week Start | First day of the week in the calendar. Can be either 'Sun' (Sunday) or 'Mon' (Monday).
Hour Mode | Which format to use when submitting or editing an object with a time setting (e.g. the publish time of a story). Can be 12 (for the 12 hour am/pm format) or 24 (for the 24 hour format).
Thousands Separator | Character to use between every group of thousands.
Decimal Separator | Character to use before decimals.
Decimal Count | How many decimal places to display.
Timezone | If your server is located in a different timezone, use this option to set your local (i.e. your own) timezone, so that the time and date on the site match your own. This option is known as the “timezone hack” and may not work on some servers.

# Miscellaneous

## Cookies

These variables define the names of all of glFusion's cookies. They can easily be changed in case there's a name collision with the cookies used by some other software package that you may use on your site.

Session Cookie Name | Name of the cookie that stores the session ID.
Permanent Cookie Name | Name of the permanent cookie.
Session IP Validation | Determines how much of the users IP is used to validate a session; All compares the complete address, A.B.C the first x.x.x, A.B the first x.x, None disables checking.
Password Cookie Name | Name of the password cookie.
Theme Cookie Name | Name of the theme cookie.
Language Cookie Name | Name of the language cookie.
Timezone Cookie Name | Name of the timezone cookie.
Cookies embed IP? | Session ID to contain IP address of user as well as random number. This is more secure but will more than likely require dialed up users to login each and every time. (0=no, 1=yes)
Permanent Timeout | Permanent cookie timeout in seconds (28800 = 8 hours).
Session Timeout | Session cookie timeout (in seconds).
Cookie Path | Cookie path (see the PHP manual for details).
Cookie Domain | The domain that the cookie is available. glFusion will attempt to guess the correct value for this setting (based on the 'site_url' variable). See the PHP manual for details.
Cookie Secure | Only set to 1 if your site uses HTTPS (see the PHP manual for details).

## Miscellaneous

PDF Enabled | PDF conversion of stories has not been fully implemented yet. Leave this option switched off to prevent unfinished options from showing up on your site.
Notifications | Send an email notification to $_CONF['site_email'] when a new story, comment, trackback or pingback has been submitted or a new user has registered with the site. The array() can hold any combination of the strings 'story', 'comment', 'trackback', 'pingback', and 'user' (separated by commas), depending on which notification(s) you want. In this web-based configuration tool, click the '+' button to add each item as an individual element. Do not include single or double quotes.
Cron Schedule Interval | glFusion can emulate a cronjob, i.e. trigger a certain action at a given time. The code to be executed can be provided by a plugin or through the CUSTOM_runScheduledTask function in your lib-custom.php. The value given is in seconds and specifies the interval in which the code should be executed. Please note that to trigger this action, you will need to have someone visit your site at around the specified time. On a site with few visitors, the code may only be executed with considerable delay. Set to 0 to disable.
Disable Autolinks | If set to 1, disables the autolinks. I.e. links using the [story:] etc. syntax are not interpreted any more.

## Debug

Root Debugging | When a PHP error occurs, glFusion's error handler will only display the actual error message to members of the Root group (to prevent leakage of possibly sensitive information). When set to true, this information will be displayed to all users. Use only for debugging purposes!

## Daily Digest

Daily Digest Enabled | Let users get stories e-mailed to them (0=no, 1=yes), aka Daily Digest. Please note that this requires cron and the use of PHP as a shell script.
Length of Stories | When emailstories (above) is enabled, send only the title and the link to the new stories (0), or send the entire introtext (1) or send the first n characters from the introtext (where n = any other number)
Enable for New Users | When set to 1, new users will be subscribed to the daily digest automatically when they register with the site.

## HTML Filtering

Allow EMBED Object | Allow the EMBED object in HTML stories and posts. This allows you to embed YouTube videos and other streaming videos in stories.
Skip HTML Filter for Root | When set to TRUE, this will allow members of the Root group to use all HTML in their posts. Use at your own risk!

## Censoring

Censor Mode | Censor submissions and comments (0=no, 1=yes)
Censor Replace Text | Text to replace a censored word with
Censor List | An array of censored words

## IP Lookup

IP Lookup | The IP addresses of comment posters are logged and displayed for admin users. When this variable is set to point to a service that can do IP address lookups, it's possible to lookup the owner of an IP address by clicking on it, making it easier to report abuse to ISPs, etc. $_CONF['ip_lookup'] should hold the complete URL to the lookup service, with a '*' marking the place where the IP address should go. It's also possible to use Tom Willet's NetTools package, in which case the correct setting would be $_CONF['ip_lookup'] = $_CONF['site_url'] . '/nettools/whois.php?domain=*';

## Webservices

Disable Webservices | Set this to true to disable the webservices.
Restrict Webservices | Set this to true to restrict webservices usage to users with the webservices.atompub permission (e.g. those in the predefined “Webservices Users” group).
Max. Stories in Webservices Feed | Max. number of stories returned when an Atom feed is requested through the webservices API.

# db-config.php

As the name implies, the file db-config.php contains the database configuration. This information is put there during the initial install and you should not normally have to edit this file.

_DB_host | localhost | Database Server (to be entered in the form: hostname:port:unixsocket). In most cases you won't need to change the default value.
_DB_name | glfusion | Database Name
_DB_user | root | Database User Account
_DB_pass | null | Database User Password
_DB_table_prefix | gl_ | Prefix to put in front of all of glFusion's table names (to avoid name collisions with tables used by other applications)
_DB_dbms | mysql | This option tells glFusion which type of database it's running on. Currently, only mysql is supported.

# siteconfig.php

The siteconfig.php file holds configuration data that can not be stored in the database. Again, most of this information is put there during the installation and you should not normally have to edit this file.

$_CONF variables
path | /path/to/glfusion/ | Base file system path for your site (trailing slash necessary)
path_system | /path/to/glfusion/system/ | Path to your system directory for your site (trailing slash necessary). This directory holds the code libraries used throughout glFusion
default_charset | iso-8859-1 | 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.
css_cache_filename | stylecache_ | 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 | jscache_ | 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.
$_SYSTEM variables
site_enabled | true | 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 | false | 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.
rootdebug | false | Display detailed error messages. This option can be useful in diagnosing errors on yoru 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.
no_fail_sql | 0 | If your site becomes unavailable due to the 'An Error has Occurred' mesage, many times it may be a problem with an upgrade or new plugin accessing the database. Set this variable to 1 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 | false | 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.
skip_ip_check | false | Disable glFusion's checking of the long term cookie against the user's IP address. As a security precaution, glFusion validates that the IP address used to create the long term cookie (used to automatically log you in) matches the IP address of the user each time it is checked. This can cause issues for users who change IPs often, for example, if they are behind a proxy server farm.
use_direct_style_js | false | 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.
$_CONF_FCK - Advanced Editor configuration options
$_CONF_FCK['editor_images_by_user'] | false | Enables 'per user' libraries for images when using the Advanced Editor. Each user will have their own 'private' library so they cannot see or use other users images.
$_CONF_FCK['imagelibrary'] | /image/library/ | The relative path to the directory where the Advanced Editor will story uploaded images.

# Calendar Plugin Configuration Options

Option | Description
--- | ---
Calendar Login Required | When set to True, only registered users can access the calendar. Please note that Login Required setting in glFusion's main configuration takes precedence over this setting. So when Login Required is True, anonymous users can not access the calendar even when this setting is False.
Hide Calendar Menu Entry | Whether to hide the “Calendar” entry from glFusion's menu bar (when set to 1) or to show it (when set to 0).
Enable Personal Calendars | Allow account holders to have a personal calendar
Enable Submission Queue | Whether events submitted by users will have to be approved by an admin first (when set = 1) or show up immediately (when set = 0).
Show upcoming Events | Whether to show upcoming events (0 = no, 1 = yes) in a separate block.
Upcoming Events Range | Number of days that the “Upcoming Events” block will look ahead.
Hour Mode | Which format to use when submitting or editing an event. Can be 12 (for the 12 hours am/pm format) or 24 (for the 24 hours format). Uses the same value as $_CONF['hour_mode'] by default.
Event Types | The set of event types that are used both on the public calendar and the user's personal calendar.
Notification Email | Whether to send an email notification when a new event was submitted for the site's calendar (when set to = 1) or not (when set to = 0). No notification is ever sent for events in personal calendars.
Delete Events with Owner | Defines what to do when a user is deleted that is the owner of an event. When set to 0, all events owned by the deleted user will be assigned to a user of the “Root” group (e.g. the site admin). When set to 1, the events are deleted. This only applies to site events - a user's personal events are always deleted.
After Saving Event | Which page to go to after an event has been saved: * 'item': display the event details * 'list': show admin's list of events (default) * 'plugin': display the calendar * 'home': display the site's homepage * 'admin': go to the “Admin Home” page, i.e. Command & Control

# Links Plugin Configuration Options

Option | Description
--- | ---
Links Login Required | When set to true, only registered users can access the links section. Please note that Login Required in glFusion's main configuration takes precedence over this setting. So when 'loginrequired' is set to 1, anonymous users can not access the links section even when Links Login Required is set to false.
Categories per Column | The number of link categories to display per column.
Links per Page | The number of links to show per page.
Show Top 10 Links | When both Categories per Column and Links per Page are not 0, the plugin will show a list of the 10 most clicked-on links on the Links plugin's index page automatically. If you do not want that “top 10” list there, set this option to false.
Show Category Description | Whether to show subcategory descriptions when viewing a category or not.
Links Admin Settings
Hide New Links | Whether new links should be hidden from the “What's New” block (when set true) or whether to list them there (when set to false).
New Links Interval | For how long a link should be considered “new” and show up in the “What's New” block on the site. The interval is given in seconds, so the default value equals 14 days.
Hide Links Menu Entry | Whether to hide the “Links” entry from glFusion's menu bar (when set to true) or to show it (when set to false).
Enable Link Submission Queue | Whether links submitted by users will have to be approved by an admin first (when set true) or show up immediately (when set false).
Notification Email | Whether to send an email notification when a new link was submitted (when set to true) or not (when set to false).
Delete Links with Owner | Defines what to do when a user is deleted that is the owner of a link. When set to false, all links owned by the deleted user will be assigned to a user of the “Root” group (e.g. the site admin). When set to true, the links are deleted.
After Saving Link | Which page to go to after a links has been saved: * 'item': go to the linked site(!) * 'list': show admin's list of links (default) * 'plugin': display the public list of links * 'home': display the site's homepage * 'admin': go to the “Admin Home” page, i.e. Command & Control
ID of Root Category | ID to use for the root of the link categories tree.

# Polls Configuration Options

Polls Login Required | When set to true, only registered users can access the list of recent polls. Please note that Login Required in glFusion's main configuration takes precedence over this setting. So when 'loginrequired' is set to 1, anonymous users can not access the Polls section even when Polls Login Required is set to false.
Hide Polls Menu Entry | Whether to hide the “Polls” entry from glFusion's menu bar (when set to true) or to show it (when set to false).
Max. Questions per Poll | Maximum number of questions in a poll.
Max. Options per Question | Maximum number of options per question.
Sort Results… | Sort answers by the number of results ('voteorder') or keep the order in which they were entered ('submitorder').
Voter Cookie valid for | Number of seconds to set a poll answer cookie to time out on.
Voter IP Address valid for | Number of seconds to set a poll answer IP address to time out on.
Delete Polls with Owner | Defines what to do when a user is deleted that is the owner of a poll. When set to false, all polls owned by the deleted user will be assigned to a user of the “Root” group (e.g. the site admin). When set to true, the polls are deleted, including all the comments posted on that poll.
After Saving Poll | Which page to go to after a poll has been saved: * 'item': display the poll * 'list': show admin's list of polls (default) * 'plugin': display the public list of polls * 'home': display the site's homepage * 'admin': go to the “Admin Home” page, i.e. Command & Control

# Spam-X Configuration Options

Option | Description
--- | ---
Enable Logging | Whether to log recognized spam posts in the spamx.log logfile (if set to true) or not (false).
Don't Filter Admin Posts | The Spam-X plugin will filter posts by any user - even site admins. This can be a problem sometimes, e.g. when you want to post a note about spam that itself contains “spammy” URLs or keywords. When this option is set to true then posts made by users in the 'spamx Admin' group are not checked for spam.
Timeout | Timeout (in seconds) for contacting external services such as SLV.
Notification Email | Email address to which spam notifications are sent when the Mail Admin action module is enabled.
Spam-X Actions | This only exists as a fallback in case $_CONF['spamx'] in glFusion's main configuration is not set. I.e. $_CONF['spamx'] takes precedence.

# Static Pages Configuration Options

Allow PHP | Whether or not to allow PHP to execute in static pages.
Sort Centerblocks by | How to sort the center blocks.
Sort Menu Entries by | Order to sort menu entries.
Delete Pages with Owner | Defines what to do when a user is deleted that is the owner of a static page. When set to false, all static pages owned by the deleted user will be assigned to a user of the “Root” group (e.g. the site admin). When set to true, the static pages are deleted, including all the comments posted on that static page.
Wrap Pages in Block | Default setting for Wrap Page in Block - When a page is wrapped in a block, the page title will be displayed above the page contents.
Show Hits | Default setting to determine if the page views will be displayed on the page.
Show Date | Default setting to determine if the last modified date will be displayed on the page.
Filter HTML | Should the contents of the static page be run through the glFusion HTML filter.
Censor Content | Should the contents of the static page be run through the glFusion content filter.
After Saving Page | Where to go after saving a static page.
Max. Pages in Web services Feed | Maximum number of pages to include in web services feed.