Wikka Documentation : ConfigurationOptions

HomePage :: Index :: RecentChanges :: Search :: Login/Register
[1182] Latest edit on 2008-09-17 17:16:13 by DarTar [typo]


Additions:
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.
Deletions:
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 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.


[1021] Edited on 2008-03-20 08:54:16 by DarTar [wikka_template_path]


Additions:



[1020] Edited on 2008-03-20 08:51:36 by DarTar [obsolete options]


Additions:
wikka_template_pathtemplatesThe path to the templates directory. It is relative to the root of your wikka directory.

Discontinued


Deletions:



[1019] Edited on 2008-03-20 08:47:02 by DarTar [documenting enable_version_check and note on root_page]


Additions:

Deletions:



[928] Edited on 2008-02-29 17:32:37 by DarTar [minor]


Additions:
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

header_action'header'Sets the php file 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 that outputs the header listed at the bottom of every page
enable_version_check1Enables automatic check of Wikka updates for admins (default: 1 - strongly recommended). Set this value to "0" to disable version upgrade check.
root_pageHomePageYour Wikka site's home page. You can use a WikiName for CamelCase linking.
root_pageHomePageYour Wikka site's home page. Should be a WikiName.
since 1.1.6.4

Deletions:



[927] Edited on 2008-02-29 15:58:18 by NilsLindenberg [tables changed to table markup]


Additions:

Deletions:
since 1.1.6.4
Overview of the config entries
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).
public_sysinfo0Toggles public vs. admin-only (default) display of system information.
Overview of the config entries
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. Should be a WikiName.
wakka_nameMyWikkaSiteThe name of your Wikka site. It usually is a WikiName
base_urlguess by 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. If you want to use HTTPS, you wil have to adjust this parameter accordingly REQUIRED.
rewrite_modeguess by installerURL rewriting enabled = '1'. URL rewriting disabled = '0'.
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 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.
wikka_formatter_pathformatterslocation of Wikka formatter - REQUIRED
wikka_highlighters_pathformatterslocation of Wikka build-in code highlighters - REQUIRED
geshi_path3rdparty/plugins/geshilocation of GeSHi package
geshi_language_path3rdparty/plugins/geshi/geshilocation of GeSHi language highlighting files
header_action'header'Sets the php file 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 that outputs the header listed at the bottom of every page
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
external_link_tailinfinity symbolThis gets tacked on to the end of any external link as a visual indicator that the link points outside of the Wiki.
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.
since 1.1.6.4

Option Default Description
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).
public_sysinfo 0 Toggles public vs. admin-only (default) display of system information.

Option Default Description
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_database wikka The MySQL database Wikka should use. 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. Should be a WikiName.
wakka_name MyWikkaSite The name of your Wikka site. It usually is a WikiName and looks SomethingLikeThis.
base_url guess by installer 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. If you want to use HTTPS, you wil have to adjust this parameter accordingly REQUIRED.
rewrite_mode guess by installer URL rewriting enabled = '1'. URL rewriting disabled = '0'.
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 '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 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.
wikka_formatter_path formatters location of Wikka formatter - REQUIRED
wikka_highlighters_path formatters location of Wikka build-in code highlighters - REQUIRED
geshi_path 3rdparty/plugins/geshi location of GeSHi package
geshi_languages_path 3rdparty/plugins/geshi/geshi location of GeSHi language highlighting 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.
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.
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' Edit note optional (',default), edit note required (1) edit note disabled (2).
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
external_link_tail infinity symbol This gets tacked on to the end of any external link as a visual indicator that the link points outside of the Wiki.
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 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 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_types mime_types.txt not in use at the moment
geshi_header div 'div' or 'pre' to wrap code block
geshi_line_numbers 1 disable line numbers (0), or enable normal (1) or fancy line numbers (2)
geshi_tab_width 4 set tab width (in spaces) in GeSHi
grabcode_button 1 enable (1) or disable (0) code block downloading.
wikiping_server
server 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
mysql_password
Password of the MySQL user used to connect to your database. REQUIRED.
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 1.1.6.2 Wikka's version number. Do not change this value! Your installation would get out of sync with the official releases.



[861] Edited on 2008-02-22 07:55:56 by DarTar [adding public_sysinfo]


Additions:

<td><code>public_sysinfo</code></td>
<td>0</td>
<td>Toggles public vs. admin-only (default) display of system information.</td>
<td>Your Wikka site's base URL. Page names get appended to it, so it should include the <code>'?wakka='</code> 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. If you want to use HTTPS, you wil have to adjust this parameter accordingly REQUIRED.</td>

Deletions:

<td>Your Wikka site's base URL. Page names get appended to it, so it should include the <code>'?wakka='</code> parameter stuff if the funky URL rewriting stuff 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! If you want to use HTTPS, you have to adjust the base dir. REQUIRED.</td>



[843] Edited on 2008-02-21 20:03:23 by DarTar [links]


Additions:
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 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.

Deletions:
The following table describes the configuration options available in the wikka.config.php file. The wikka.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.



[818] Edited on 2008-02-21 18:20:05 by DarTar [adding CSS class]


Additions:
<table border="1" class="data">

Deletions:
<table border="1">



[817] Edited on 2008-02-21 18:01:50 by BrianKoontz [rearranged sections for better clarity]


No Differences


[677] Edited on 2008-02-18 01:16:34 by BrianKoontz [Minor edit]


Additions:
since 1.1.6.2

Deletions:
Since Wikka 1.1.6.2
 



[676] Edited on 2008-02-18 01:15:35 by BrianKoontz [Minor layout change]


Additions:
since 1.1.6.4



[675] Edited on 2008-02-18 01:09:05 by BrianKoontz [allow_user_registration]


Additions:

<td><code>allow_user_registration</code></td>
<td>1</td>
<td>Setting this to "1" (default) allows user registrations. Setting this value to "0" disables all new user registrations (logins remain enabled).</td>



[304] Edited on 2006-11-19 09:45:27 by YanB [lots of formatting changes and updates]


Additions:
HomePage
Since Wikka 1.1.6.2
 

The following table describes the configuration options available in the wikka.config.php file. The wikka.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.
""<table border="1">
<td> <code>mysql_host</code></td>
<td>The host your MySQL server is running on. Usually <code>localhost</code> i.e., the same machine your Wikka site is on. REQUIRED</td>
<td> <code>mysql_database</code></td>
<td>The MySQL database Wikka should use. REQUIRED.</td>
<td><code> mysql_user</code></td>
<td>Name of the MySQL user used to connect to your database. REQUIRED.</td>
<td> <code>table_prefix</code></td>
<td><code>wikka_</td>
<td>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.</td>
<td> <code>root_page</code></td>
<td><code>HomePage</code></td>
<td><code> wakka_name</code></td>
<td><code>MyWikkaSite</code></td>
<td> <code>base_url</code></td>
<td>guess by installer</code></td>
<td>Your Wikka site's base URL. Page names get appended to it, so it should include the <code>'?wakka='</code> parameter stuff if the funky URL rewriting stuff 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! If you want to use HTTPS, you have to adjust the base dir. REQUIRED.</td>
<td> <code>rewrite_mode</code></td>
<td>URL rewriting enabled = <code>'1'</code>. URL rewriting disabled = <code>'0'</code>.</td>
<td> <code>wiki_suffix</code></td>
<td><code>@wikka</code></td>
<td> <code>action_path</code></td>
<td><code>'actions'</code></td>
<td>The path to the <code>actions</code> directory. It is relative to the root of your wikka directory.</td>
<td><code> handler_path</code></td>
<td><code>'handlers'</code></td>
<td>The path to the <code>handlers</code> directory. It is relative to the root of your wikka directory.</td>
<td> <code>gui_editor</code></td>
<td><code>'1'</code></td>
<td> <code>stylesheet</code></td>
<td><code>'wikka.css'</code></td>
<td>Specifies which cascading stylesheet to use. Stylesheets are stored in the <code>css</code> directory. (Make sure your webserver has read access to the <code>css</code> directory and the <code>*.css</code> files.</td>
<td><code>wikka_formatter_path</code></td>
<td><code>formatters</code></td>
<td><code>wikka_highlighters_path</code></td>
<td><code>formatters</code></td>
<td><code>geshi_path</code></td>
<td><code>3rdparty/plugins/geshi</code></td>
<td><code>geshi_languages_path</code></td>
<td><code>3rdparty/plugins/geshi/geshi</code></td>
<td><code>header_action</code></td>
<td><code>'header'</code></td>
<td>Sets the php file in the <code>'actions'</code> 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)</td>
<td> <code>footer_action</code></td>
<td><code>'footer'</code></td>
<td>Sets the php file in the <code>actions</code> directory that outputs the footer listed at the bottom of every page.</td>
<td> <code>navigation_links</code></td>
<td> <code>logged_in_navigation_links</code></td>
<td><code> referrers_purge_time</code></td>
<td><code>'30'</code></td>
<td>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.</td>
<td> <code>pages_purge_time</code></td>
<td><code>'0'</code></td>
<td> 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.</td>
<td><code> xml_recent_changes</code></td>
<td><code>10</code></td>
<td> <code>hide_comments</code></td>
<td><code>'0'</code></td>
<td><code> require_edit_note</code></td>
<td><code>'0'</code></td>
<td>Edit note optional <code>(',default)</code>, edit note required (1) edit note disabled (2).</td>
<td> <code>anony_delete_own_comments</code></td>
<td><code>'1'</code></td>
<td> <code>double_doublequote_html</code></td>
<td><code>'safe'</code></td>
<td>determines if HTML in wikkapages is passed through SafeHtml ('safe'), shown as it is ('raw') or passed through <code>htmlspecialchars_en</code> (anything else)</td>
<td><code> public_sysinfo</code></td>
<td><code>'0'</code></td>
<td><code> external_link_tail</code></td>
<td><code> sql_debugging</code></td>
<td><code>'0'</code></td>
<td> <code>admin_users</code></td>
<td>A list of users allowed to administer the wiki. Specify multiple wiki names separated by commas e.g: DarTar, NilsLindenberg, YanB</td>
<td><code> admin_email</code></td>
<td><code> upload_path</code></td>
<td><code>'uploads'</code></td>
<td> <code>mime_types</code></td>
<td><code>mime_types.txt</code></td>
<td> geshi_header</code></td>
<td><code>div</code></td>
<td><code>'div'</code> or <code>'pre'</code> to wrap code block</td>
<td><code> geshi_line_numbers</code></td>
<td><code>1</code></td>
<td> <code>geshi_tab_width</code></td>
<td><code>4</code></td>
<td> <code>grabcode_button</code></td>
<td><code>1</code></td>
<td><code> wikiping_server</code></td>
<td> <code>default_write_acl</code></td>
<td><code>'+'</code></td>
<td> <code>default_read_acl</code></td>
<td><code>'*'</code></td>
<td>Reading-access to pages. See <code>default_write_acl</code></td>
<td> <code>default_comment_acl</code></td>
<td><code>'*'</code></td>
<td>The right to comment pages. See <code>default_write_acl</code></td>
<td> <code>mysql_password</code></td>
<td>Password of the MySQL user used to connect to your database. REQUIRED.</td>
<td> <code>meta_keywords</code></td>
<td> <code>meta_description</code></td>
<td> <code>wakka_version</code></td>
<td><code>1.1.6.2</code></td>
CategoryEN

Deletions:
Wikka Documentation
Since Wikka 1.1.6.2
 

The following table describes the configuration options available in the wikka.config.php file. The wikka.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.
""<table>
<td> mysql_host</td>
<td>The host your MySQL server is running on. Usually localhost I.e., the same machine your Wikka site is on.</td>
<td> mysql_database</td>
<td>The MySQL database Wikka should use.</td>
<td> mysql_user</td>
<td>Name of the MySQL user used to connect to your database.</td>
<td> table_prefix</td>
<td>wikka_</td>
<td>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.</td>
<td> root_page</td>
<td>HomePage</td>
<td> wakka_name</td>
<td>MyWikkaSite</td>
<td> base_url</td>
<td>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 this only if you know what you're doing! If you want to use HTTPS, you have to adjust the base dir</td>
<td> rewrite_mode</td>
<td>URL rewriting enabled = '1'. URL rewriting disabled = '0'.</td>
<td> wiki_suffix</td>
<td>@wikka</td>
<td> action_path</td>
<td>'actions'</td>
<td>The path to the action directory. It is relative to the root of your wikka directory.</td>
<td> handler_path</td>
<td>'handlers'</td>
<td>The path to the handler directory. It is relative to the root of your wikka directory.</td>
<td> gui_editor</td>
<td>'1'</td>
<td> stylesheet</td>
<td>'wikka.css'</td>
<td>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.</td>
<td>wikka_formatter_path</td>
<td>formatters</td>
<td>wikka_highlighters_path</td>
<td>formatters</td>
<td>geshi_path</td>
<td>3rdparty/plugins/geshi</td>
<td>geshi_languages_path</td>
<td>3rdparty/plugins/geshi/geshi</td>
<td>header_action</td>
<td>'header'</td>
<td>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)</td>
<td> footer_action</td>
<td>'footer'</td>
<td>Sets the php file in the actions directory that outputs the footer listed at the bottom of every page.</td>
<td> navigation_links</td>
<td> logged_in_navigation_links</td>
<td> referrers_purge_time</td>
<td>'30'</td>
<td>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.</td>
<td> pages_purge_time</td>
<td>'0'</td>
<td> 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.</td>
<td> xml_recent_changes</td>
<td>10</td>
<td> hide_comments</td>
<td>'0'</td>
<td> require_edit_note</td>
<td>'0'</td>
<td>Edit note optional (',default), edit note required (1) edit note disabled (2).</td>
<td> anony_delete_own_comments</td>
<td>'1'</td>
<td> double_doublequote_html</td>
<td>'safe'</td>
<td>determines if HTML in wikkapages is passed through SafeHtml ('safe'), shown as it is ('raw') or passed thourgh htmlspecialchars_en (anything else)</td>
<td> public_sysinfo</td>
<td>'0'</td>
<td> external_link_tail</td>
<td> sql_debugging</td>
<td>'0'</td>
<td> admin_users</td>
<td>A list of users allowed to administer the wiki. Specify multiple wiki names separated by commas e.g: JsnX, HendrikMans, CoolJoeAdmin </td>
<td> admin_email</td>
<td> upload_path</td>
<td>'uploads'</td>
<td> mime_types</td>
<td>mime_types.txt</td>
<td> geshi_header</td>
<td>div</td>
<td>'div' or 'pre' to wrap code block</td>
<td> geshi_line_numbers</td>
<td>1</td>
<td> geshi_tab_width</td>
<td>4</td>
<td> grabcode_button</td>
<td>1</td>
<td> wikiping_server</td>
<td> default_write_acl</td>
<td>'+'</td>
<td> default_read_acl</td>
<td>'*'</td>
<td>Reading-access to pages. See default_write_acl</td>
<td> default_comment_acl</td>
<td>'*'</td>
<td>The right to comment pages. See default_write_acl</td>
<td> mysql_password</td>
<td><br /></td>
<td>Password of the MySQL user used to connect to your database.</td>
<td> meta_keywords</td>
<td><br />
</td>
<td> meta_description</td>
<td><br /></td>
<td> wakka_version</td>
<td>1.1.6.2</td>
CategoryDocumentation



[169] The oldest known version of this page was created on 2006-06-14 02:58:45 by DarTar [note on version, minor changes]

History of recent changes for ConfigurationOptions
Wikka Documentation

Wikka Configuration Options (wikka.config.php)


Since Wikka 1.1.6.2
 

The following table describes the configuration options available in the wikka.config.php file. The wikka.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 Description
mysql_host localhost The host your MySQL server is running on. Usually localhost I.e., the same machine your Wikka site is on.
mysql_database wikka The MySQL database Wikka should use.
mysql_user wikka Name of the MySQL user used to connect to your database.
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.
root_page HomePage Your Wikka site's home page. Should be a WikiName.
wakka_name MyWikkaSite The name of your Wikka site. It usually is a WikiName and looks SomethingLikeThis.
base_url guess by installer 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 this only if you know what you're doing! If you want to use HTTPS, you have to adjust the base dir
rewrite_mode guess by installer URL rewriting enabled = '1'. URL rewriting disabled = '0'.
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 '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.
wikka_formatter_path formatters location of Wikka formatter - REQUIRED
wikka_highlighters_path formatters location of Wikka build-in code highlighters - REQUIRED
geshi_path 3rdparty/plugins/geshi location of GeSHi package
geshi_languages_path 3rdparty/plugins/geshi/geshi location of GeSHi language highlighting 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.
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' Edit note optional (',default), edit note required (1) edit note disabled (2).
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 thourgh htmlspecialchars_en (anything else)
public_sysinfo '0' enable or disable public display of system information in SysInfo
external_link_tail infinity symbol This gets tacked on to the end of any external link as a visual indicator that the link points outside of the Wiki.
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 created during 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 setup during installation. Email address of the wiki administrator.
upload_path 'uploads' The path to the directory file attachments will be stored in.
mime_types mime_types.txt not in use at the moment
geshi_header div 'div' or 'pre' to wrap code block
geshi_line_numbers 1 disable line numbers (0), or enable normal (1) or fancy line numbers (2)
geshi_tab_width 4 set tab width (in spaces) in GeSHi
grabcode_button 1 enable (1) or disable (0) code block downloading.
wikiping_server
server 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
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 1.1.6.2 Wikka's version number. Do not change this value! Your installation would get out of sync with the official releases.



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