Revision [1574]

This is an old revision of ConfigurationOptions made by DarTar on 2004-10-03 21:54:21.

 

WikkaDocumentation Wikka Documentation

Wikka Configuration Options (wikka.config.php)


The following table describes the configuration options available in the wakka.config.php file. The wakka.config.php file is generated by the wikka installer. It is intended to be edited only by the web site admin, because it contains sensitive password information and crucial configuration options for the operation of Wikka.

Use a FTP client to edit this file on the web server.

Feel free to fill in or leave comments about any missing info.

Option Default Descrioption
mysql_host
The host your MySQL server is running on. Usually localhost I.e., the same machine your Wikka site is on.
mysql_database
The MySQL database Wikka should use.
mysql_user
Name of the MySQL user used to connect to your database.
table_prefix
Prefix of all tables used by Wikka. This allows you to run multiple Wikka installations using the same MySQL database by configuring them to use different table prefixes.
root_page
Your Wikka site's home page. Should be a WikiName.
wakka_name
The name of your Wikka site. It usually is a WikiName and looks SomethingLikeThis.
base_url
Your Wikka site's base URL. Page names get appended to it, so it should include the '?wakka=' parameter stuff if the funky URL rewriting stuff doesn't work on your server. The wikka installer tries to guess the proper value. Change them only if you know what you're doing!
rewrite_mode
URL rewriting enabled = '1'. URL rewriting disabled = '0'.
action_path 'actions' The path to the action directory. It is relative to the root of your wikka directory.
handler_path 'handlers' The path to the handler directory. It is relative to the root of your wikka directory.
gui_editor '1' When set to '1', users see a toolbar when editing pages that allows them to apply some of the markup by clicking toolbar buttons. When set to '0', the toolbar is disabled.
stylesheet 'wikka.css' Specifies which cascading stylesheet to use. Stylesheets are stored in the css directory. (Make sure your webserver has read access to the css directory and the *.css files.
header_action 'header' Sets the php file in the 'actions' directory that outputs the header listed at the top of every page and everything that appears above the header (like the HTML head and DOCTYPE)
footer_action 'footer' Sets the php file in the actions directory that outputs the footer listed at the bottom of every page.
navigation_links
Specifies the navigation links that are output in the header and displayed to all users.
logged_in_navigation_links
Specifies the navigation links that are output in the header and displayed to logged in users.
referrers_purge_time '30' The number of days referring pages (pages that link to your wiki) are kept in the referral logs. Setting this option to '0' or leaving it empty disables the referrer log. (I THINK. DOES IT REALLY PURGE THE LOG, OR DOES IT SIMPLY NOT DISPLAY IT?) - It really purges the log. See below for the actual code that does this.
pages_purge_time '0' Setting pages_purge_time will remove old page revisions older than the specified setting. So if you set this to 7, page revisions older than 7 days will be deleted. The most recent pages will never be purged. If you have a huge wiki with thousands of pages that are all frequently updated you might want to turn this on, but most wikis will never need to adjust this setting.
xml_recent_changes 10 Number of recent change items that are sent when the RecentChanges feed is accessed.
show_spaces N If set to 'Y', new users will see WikiWords with spaces inserted (WikiWords -->
Wiki Words). Users can override this option by checking 'Show spaces in WikiWords' in the UserSettings page. hide_comments '0'
If set to '1', Comments and the 'Add Comment' form will not be visible. If set to '0', users can see and add comments. anony_delete_own_comments '1'
If set to '1', anonymous users can delete their own comments, provided they do so from the host machine they used to create the comment. If '0', anonymous users cannot delete their own comments. allow_doublequote_html '0'
If set to '1', users can insert arbitrary HTML into the rendered page using double double-quotes. If set to '0', users can't insert arbitrary HTML into the rendered page. This is disabled by default. external_link_tail
This gets tacked on to the end of any external link as a visual indicator that the link points outside of the Wiki. By default the infinity symbol is used. sql_debugging '0'
Set this to '1' to see all of the database queries that are made when a page is generated. The queries will appear at the bottom of the page. admin_users Admin user you setup at installation.
A list of users allowed to administer the wiki. Specify multiple wiki names separated by commas e.g: JsnX, HendrikMans, CoolJoeAdmin admin_email Admin email addres you setup at install.
Email address of the wiki administrator. upload_path 'uploads'
The path to the directory file attachments will be stored in. mime_types

default_write_acl '*'
If set to '*', when a new page is created, anyone can edit it. If set to '+', any registered and logged in user can edit a new page. List individual WikiNames one to a line to only allow specific users to edit new pages by default. default_read_acl '*'
If set to '*', when a new page is created, anyone can view it. If set to '+', any registered and logged in user can view the new page. List individual WikiNames one to a line to only allow specific users to view new pages by default. default_comment_acl '*'
If set to '*', when a new page is created, anyone can leave a comment on it. If set to '+', any registered and logged in user can leave a comment on a new page. List individual WikiNames one to a line to only allow specific users to leave comments on new pages by default. mysql_password
Password of the MySQL user used to connect to your database. meta_keywords
This is set during install. Controls the meta tag keywords included in the head of every Wikka page. meta_description
This is set during install. Controls the meta tag description included in the head of every Wikka page. wakka_version
Lists wikka version number. The config file warns against changing this so that your installation doesn't get out of sync with the official releases.



CategoryDocumentation
There are 30 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki