Wikka Documentation : ConfigurationOptions

HomePage :: Index :: RecentChanges :: Search :: Login/Register
[2308] Latest edit on 2012-09-13 02:03:25 by DotMG [default_locale needs to be documented]


Additions:



[2259] Edited on 2011-09-25 10:05:35 by BrianKoontz [deprecated base_url]


Additions:

Deletions:



[2182] Edited on 2010-08-06 20:19:16 by BrianKoontz [added utf8_compat_search]


Additions:



[2170] Edited on 2010-07-08 08:28:33 by DarTar [new settings as of 1.3]


Additions:
default_locale todo
base_url(autodetected)Your Wikka site's base URL. Page names get appended to it, so it should include the '?wakka=' bit if URL rewriting doesn't work on your server. The Wikka installer tries to guess the proper value. Change this only if you know what you're doing, see ModRewrite for further information. If you wish to use HTTPS, you will have to adjust this parameter accordingly REQUIRED.
until 1.3.2
base_url(autodetected)Your Wikka site's base URL. Page names get appended to it, so it should include the '?wakka=' bit if URL rewriting doesn't work on your server. The Wikka installer tries to guess the proper value. Change this only if you know what you're doing, see ModRewrite for further information. If you wish to use HTTPS, you will have to adjust this parameter accordingly REQUIRED.
utf8_compat_search'0' '0' for legacy search (case-sensitive, wildcards, but incompatible with some character encodings [default]); '1' for UTF-8 compatible searches (non-case-sensitive, no wildcards).
since 1.3


Deletions:



[2154] Edited on 2010-06-29 15:57:22 by BrianKoontz [Added default_comment_display config param]


Additions:



[2074] Edited on 2009-09-02 03:53:23 by DarTar [formatting]


Additions:

Deletions:



[2073] Edited on 2009-09-02 03:52:36 by DarTar [default -> light]


Additions:

Deletions:



[2072] Edited on 2009-09-02 03:52:21 by DarTar [default -> light]


Additions:

Deletions:



[2044] Edited on 2009-08-30 12:39:40 by BrianKoontz [Added stylesheet_hash param]


Additions:

Deletions:



[2043] Edited on 2009-08-30 12:34:05 by BrianKoontz [Added safehtml_path param]


Additions:



[2042] Edited on 2009-08-29 02:09:50 by BrianKoontz [Added enable_user_host_lookup entry]


Additions:



[2034] Edited on 2009-08-19 08:14:52 by DarTar [formatting default values]


Additions:

Deletions:



[2033] Edited on 2009-08-19 08:09:31 by DarTar [discontinued options]


Additions:

Deletions:



[2032] Edited on 2009-08-19 08:08:03 by DarTar [formatting]


Additions:

Deletions:



[2031] Edited on 2009-08-19 08:07:18 by DarTar [theme option, obsoleting stylesheet]


Additions:

Deletions:



[1994] Edited on 2009-07-12 01:28:45 by BrianKoontz [Added new {{checkversion}} config param]


Additions:
default_comment_read_acl'*'Sets the default permissions for reading comments.
default_comment_write_acl'+'Sets the default permissions for posting comments.
default_comment_acl'*'Sets the default rights for commenting pages. See default_write_acl
until 1.2
default_comment_acl'*'The right to comment pages. See default_write_acl
default_comment_display'threaded'How comments are displayed to anonymous users or newly registered users. Options are 'threaded' (default, comments are nested), 'date_asc' (listing starts with oldest comment), and 'date_desc' (listing starts with newest comment). These are configurable on a per-user basis in the UserSettings page.
stylesheet_hash(random sequence)Internally generated during installation/upgrade to ensure stylesheets are reloaded when accessing the new site for the first time.
stylesheet_hashRandom sequenceInternally generated during installation/upgrade to ensure stylesheets are reloaded when accessing the new site for the first time.
theme'light'Global theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. As of 1.2 it defaults to light.
theme'default'Global theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. As of 1.2 it defaults to light.
theme'default'Global theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. As of 1.2 it defaults to light.
theme'default'Global theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. It defaults to default.
safehtml_path'3rdparty/core/safehtml'Path to SafeHTML code module.
stylesheet_hashRandom sequenceInternally generated during installation/upgrade to ensure stylesheets are reloaded when accessing the new site for the first time.
safehtml_path'3rdparty/core/safehtml'Path to SafeHTML code module
safehtml_path'3rdparty/core/safehtml'Path to SafeHTML code module
enable_user_host_lookup'1'Enables ('1') or disables ('0') lookup of user hostname from IP address. Disable this setting when reverse DNS lookups are slow or not available. Default is '1'.
version_check_interval'1h'Minimum time interval between version checks. Possible interval units are h (hours), m (minutes), s (seconds), d (days), w (weeks), M (months), and y (years).
allow_user_registration'1'Setting this to "1" (default) allows user registrations. Setting this value to "0" disables all new user registrations (logins remain enabled).
enable_version_check'1'Enables automatic check of Wikka updates for admins (default: 1 - strongly recommended). Set this value to "0" to disable version upgrade check.
public_sysinfo'0'Toggles public vs. admin-only (default) display of system information.
mysql_host'localhost'The host your MySQL server is running on. Usually localhost i.e., the same machine your Wikka site is on. REQUIRED
mysql_user'wikka'Name of the MySQL user used to connect to your database. REQUIRED.
table_prefix'wikka_'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. REQUIRED.
root_page'HomePage'Your Wikka site's home page. You can use a WikiName for CamelCase linking.
wakka_name'MyWikkaSite'The name of your Wikka site. It usually is a WikiName
base_url(autodetected)Your Wikka site's base URL. Page names get appended to it, so it should include the '?wakka=' bit if URL rewriting doesn't work on your server. The Wikka installer tries to guess the proper value. Change this only if you know what you're doing, see ModRewrite for further information. If you wish to use HTTPS, you will have to adjust this parameter accordingly REQUIRED.
rewrite_mode(autodetected)URL rewriting enabled = '1'. URL rewriting disabled = '0'. See ModRewrite for further information
wiki_suffix'@wikka'Used to distinguish different wikkas. If you want to have more then one wikka on the same server, you'll have to set a different suffix for all of them.
action_path'plugins/actions, actions'The path to the actions directory. It is relative to the root of your wikka directory. Additionally, path to the plugins/actions directory
since 1.1.6.6
wikka_formatter_path'plugins/formatters, formatters'location of Wikka formatter - REQUIRED Additionally, path to the plugins/formatters directory
since 1.1.6.6
wikka_highlighters_path'formatters'location of Wikka built-in code highlighters - REQUIRED
geshi_path'3rdparty/plugins/geshi'location of GeSHi package
geshi_language_path'3rdparty/plugins/geshi/geshi'location of GeSHi language highlighting files
xml_recent_changes'10'Number of recent change items that are sent when the RecentChanges feed is accessed.
admin_users(admin user created during installation)A list of users allowed to administer the wiki. Specify multiple wiki names separated by commas e.g: DarTar, NilsLindenberg, YanB
admin_email(admin email address setup during installation)Email address of the wiki administrator.
mime_types'mime_types.txt'not in use at the moment
geshi_header'div'div or 'pre' to wrap code block
wakka_version'1.2'Wikka's version number. Do not change this value! Your installation would get out of sync with the official releases.
navigation_linksSpecifies the navigation links that are output in the header and displayed to all users.
until 1.1.6.7
logged_in_navigation_linksSpecifies the navigation links that are output in the header and displayed to logged in users.
until 1.1.6.7
version_check_interval1hMinimum time interval between version checks. Possible interval units are h (hours), m (minutes), s (seconds), d (days), w (weeks), M (months), and y (years).
allow_user_registration1Setting this to "1" (default) allows user registrations. Setting this value to "0" disables all new user registrations (logins remain enabled).
enable_version_check1Enables automatic check of Wikka updates for admins (default: 1 - strongly recommended). Set this value to "0" to disable version upgrade check.
public_sysinfo0Toggles public vs. admin-only (default) display of system information.
mysql_hostlocalhostThe host your MySQL server is running on. Usually localhost i.e., the same machine your Wikka site is on. REQUIRED
mysql_userwikkaName of the MySQL user used to connect to your database. REQUIRED.
table_prefixwikka_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. REQUIRED.
root_pageHomePageYour Wikka site's home page. You can use a WikiName for CamelCase linking.
wakka_nameMyWikkaSiteThe name of your Wikka site. It usually is a WikiName
base_urldetected by the installerYour Wikka site's base URL. Page names get appended to it, so it should include the '?wakka=' bit if URL rewriting doesn't work on your server. The Wikka installer tries to guess the proper value. Change this only if you know what you're doing, see ModRewrite for further information. If you wish to use HTTPS, you will have to adjust this parameter accordingly REQUIRED.
rewrite_modedetected by the installerURL rewriting enabled = '1'. URL rewriting disabled = '0'. See ModRewrite for further information
wiki_suffix@wikkaUsed to distinguish different wikkas. If you want to have more then one wikka on the same server, you'll have to set a different suffix for all of them.
action_path'plugins/actions,actions'The path to the actions directory. It is relative to the root of your wikka directory. Additionally, path to the plugins/actions directory
since 1.1.6.6
wikka_formatter_pathplugins/formatters,formatterslocation of Wikka formatter - REQUIRED Additionally, path to the plugins/formatters directory
since 1.1.6.6
wikka_highlighters_pathformatterslocation of Wikka built-in code highlighters - REQUIRED
geshi_path3rdparty/plugins/geshilocation of GeSHi package
geshi_language_path3rdparty/plugins/geshi/geshilocation of GeSHi language highlighting files
navigation_linksSpecifies the navigation links that are output in the header and displayed to all users.
logged_in_navigation_linksSpecifies the navigation links that are output in the header and displayed to logged in users.
xml_recent_changes10Number of recent change items that are sent when the RecentChanges feed is accessed.
admin_usersAdmin user created during installation.A list of users allowed to administer the wiki. Specify multiple wiki names separated by commas e.g: DarTar, NilsLindenberg, YanB
admin_emailAdmin email addres setup during installation.Email address of the wiki administrator.
mime_typesmime_types.txtnot in use at the moment
geshi_headerdivdiv or 'pre' to wrap code block
wakka_version1.1.6.4Wikka's version number. Do not change this value! Your installation would get out of sync with the official releases.
external_link_tail'∞'Appended to any external link as a visual indicator that the link points to a location outside the wiki
until 1.1.6.5
.
external_link_tailinfinity symbolAppended to any external link as a visual indicator that the link points to a location outside the wiki
until 1.1.6.5
.
theme'default'Global theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. It defaults to default.
wikka_template_path'plugins/templates, templates'The path to the templates directory. It is relative to the root of your wikka directory.
themedefaultGlobal theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. It defaults to default.
wikka_template_pathtemplatesThe path to the templates directory. It is relative to the root of your wikka directory.
themedefaultGlobal theme selected by the wiki owner. It should match the name of an existing folder under templates/ or plugins/templates. It defaults to default.
stylesheet'wikka.css'Specifies the name of the 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.
until 1.1.6.7
stylesheet'wikka.css'Specifies the name of the 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.
since 1.2




[1929] Edited on 2009-02-16 16:25:22 by NilsLindenberg [+ plugin/ dirctories]


Additions:

Deletions:



[1770] Edited on 2009-01-19 00:19:19 by BrianKoontz [Removed reference to additional_stylesheets]


Additions:

Deletions:



[1769] Edited on 2009-01-19 00:18:05 by BrianKoontz [Removed reference to additional_stylesheets]


Deletions:
version_check_interval1hMinimum time interval between version checks. Possible interval units are h (hours), m (minutes), s (seconds), d (days), w (weeks), M (months), and y (years).
action_path'plugins/actions,actions'The path to the actions directory. It is relative to the root of your wikka directory. Additionally, path to the plugins/actions directory
since 1.1.6.6
handler_path'plugins/handlers,handlers'The path to the handlers directory. It is relative to the root of your wikka directory. Additionally, path to the plugins/handlers directory
since 1.1.6.6
wikka_formatter_pathplugins/formatters,formatterslocation of Wikka formatter - REQUIRED Additionally, path to the plugins/formatters directory
since 1.1.6.6
action_path'actions'The path to the actions directory. It is relative to the root of your wikka directory.
handler_path'handlers'The path to the handlers directory. It is relative to the root of your wikka directory.
wikka_formatter_pathformatterslocation of Wikka formatter - REQUIRED
stylesheet'wikka.css'Specifies the name of the 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.
stylesheet'wikka.css'Specifies the name of the 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. Additional stylesheets can be specified since 1.1.6.6 using the additional_stylesheet option
since 1.1.6.6




[1717] Edited on 2009-01-14 07:12:12 by DarTar [moving external_link_tail to obsolete settings]

History of recent changes for ConfigurationOptions
additional_stylesheetsSpecifies a space-delimited list of CSS stylesheets to be included in the HTML-rendered Wikka page (in addition to stylesheets loaded by default and specified via the stylesheet setting).

Wikka Configuration Options (wikka.config.php)



See also
The table below lists the configuration options available in the wikka.config.php file. The wikka.config.php file is generated by the installer when installing Wikka for the first time and when upgrading from previous versions. It is intended to be edited only by the web site admin only, because it contains sensitive password information and crucial configuration options for the operation of Wikka. You can use a FTP client to edit this file on your web server.


since 1.1.6.6

OptionDefaultDescription
additional_stylesheetsSpecifies a space-delimited list of CSS stylesheets to be included in the HTML-rendered Wikka page (in addition to stylesheets loaded by default and specified via the stylesheet setting).

since 1.1.6.4

OptionDefaultDescription
allow_user_registration1Setting this to "1" (default) allows user registrations. Setting this value to "0" disables all new user registrations (logins remain enabled).
enable_version_check1Enables automatic check of Wikka updates for admins (default: 1 - strongly recommended). Set this value to "0" to disable version upgrade check.
public_sysinfo0Toggles public vs. admin-only (default) display of system information.
wikka_template_pathtemplatesThe path to the templates directory. It is relative to the root of your wikka directory.

since 1.1.6.2

OptionDefaultDescription
mysql_hostlocalhostThe host your MySQL server is running on. Usually localhost i.e., the same machine your Wikka site is on. REQUIRED
mysql_userwikkaName of the MySQL user used to connect to your database. REQUIRED.
mysql_passwordPassword of the MySQL user used to connect to your database. REQUIRED.
table_prefixwikka_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. REQUIRED.
root_pageHomePageYour Wikka site's home page. You can use a WikiName for CamelCase linking.
wakka_nameMyWikkaSiteThe name of your Wikka site. It usually is a WikiName
base_urldetected by the installerYour Wikka site's base URL. Page names get appended to it, so it should include the '?wakka=' bit if URL rewriting doesn't work on your server. The Wikka installer tries to guess the proper value. Change this only if you know what you're doing, see ModRewrite for further information. If you wish to use HTTPS, you will have to adjust this parameter accordingly REQUIRED.
rewrite_modedetected by the installerURL rewriting enabled = '1'. URL rewriting disabled = '0'. See ModRewrite for further information
wiki_suffix@wikkaUsed to distinguish different wikkas. If you want to have more then one wikka on the same server, you'll have to set a different suffix for all of them.
action_path'actions'The path to the actions directory. It is relative to the root of your wikka directory.
handler_path'handlers'The path to the handlers directory. It is relative to the root of your wikka directory.
gui_editor'1'When set to '1', users see a toolbar (WikkaEdit) 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 the name of the 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. Additional stylesheets can be specified since 1.1.6.6 using the additional_stylesheet option
wikka_formatter_pathformatterslocation of Wikka formatter - REQUIRED
wikka_highlighters_pathformatterslocation of Wikka built-in code highlighters - REQUIRED
geshi_path3rdparty/plugins/geshilocation of GeSHi package
geshi_language_path3rdparty/plugins/geshi/geshilocation of GeSHi language highlighting files
navigation_linksSpecifies the navigation links that are output in the header and displayed to all users.
logged_in_navigation_linksSpecifies 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.
pages_purge_time'0' Setting <code>pages_purge_time</code> 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_changes10Number of recent change items that are sent when the RecentChanges feed is accessed.
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.
require_edit_note'0'
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.
double_doublequote_html'safe'determines if HTML in wikkapages is passed through SafeHtml ('safe'), shown as it is ('raw') or passed through htmlspecialchars_en (anything else)
public_sysinfo'0'enable or disable public display of system information in SysInfo
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_usersAdmin user created during installation.A list of users allowed to administer the wiki. Specify multiple wiki names separated by commas e.g: DarTar, NilsLindenberg, YanB
admin_emailAdmin email addres setup during installation.Email address of the wiki administrator.
upload_path'uploads'The path to the directory file attachments will be stored in.
mime_typesmime_types.txtnot in use at the moment
geshi_headerdivdiv or 'pre' to wrap code block
geshi_line_numbers1disable line numbers (0), or enable normal (1) or fancy line numbers (2)
geshi_tab_width4set tab width (in spaces) in GeSHi
grabcode_button1enable (1) or disable (0) code block downloading.
wikiping_serverserver to report your recentchanges to. See WikiPing for details
default_write_acl'+'write-access to pages. See AclInfo for details. Changes here only affect newly created pages, not existing ones! Common values are '*' (everyone), '+' (registered users) 'UserName' (user with Username)
default_read_acl'*'Reading-access to pages. See default_write_acl
default_comment_acl'*'The right to comment pages. See default_write_acl
meta_keywordsThis is set during install. Controls the meta tag keywords included in the head of every Wikka page.
meta_descriptionThis is set during install. Controls the meta tag description included in the head of every Wikka page.
wakka_version1.1.6.4Wikka's version number. Do not change this value! Your installation would get out of sync with the official releases.

Discontinued

OptionDefaultDescription
external_link_tailinfinity symbolAppended to any external link as a visual indicator that the link points to a location outside the wiki
until 1.1.6.5
.
header_action'header'Specifies the name of the file that generates the header of wiki pages
until 1.1.6.3
footer_action'footer'Specifies the name of the file that generates the footer of every wiki page
until 1.1.6.3



CategoryEN
Full history for this page cannot be displayed within a single page, click herehere to view more.

Creative Common Attribution-ShareAlike License
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.0527 seconds