- VW3
- VaultWiki: Server Settings
Return to current revision
Current Revision
January 6, 2015, 1:50 PM
General Differences
made the following changes
- changed the title prefix from 'Help' to 'VW3'
- changed the meta description
-
-
This setting group from the vBulletin options will allow the Administrator to change important configuration settings for VaultWiki. -
+
This page is about the "VaultWiki: Server Settings" group located in vBulletin Options > vBulletin Options (Settings > Options in vBulletin 4). This group will allow the Administrator to change importan
-
Differences in Content
-
-
This setting group from the vBulletin options will allow the Administrator to change important configuration settings for VaultWiki. -
+
This page is about the "VaultWiki: Server Settings" group located in [color="DimGray"]vBulletin Options > vBulletin Options[/color] ([color="DimGray"]Settings > Options[/color] in vBulletin 4). This group will allow the Administrator to change important configuration settings for VaultWiki.
[image]server-settings.jpg|center[/image]
[template]Warning Box | Note | Some "VaultWiki: Server Settings" require you to make changes to your server's [book]Mod Rewrite Configuration[/book]. If your server or host does not support this, do not make changes to those settings.[/template] -
-
-
Turn on the Wiki -
+
[H="3"]Turn on the Wiki[/H] -
From time to time, you may want to turn your wiki off to the public while you perform maintenance, update versions, etc.
-
-
Selecting 'Yes' will Enable the wiki.
Selecting 'No' will Disable the wiki. -
+
Selecting 'Yes' will show the wiki to your visitors.
Selecting 'No' will hide the wiki from your visitors. -
When the wiki is Disabled, users in the Administrator usergroup will still be able to browse the wiki. Other visitors will see an error message stating that the wiki is temporarily unavailable.
-
-
Wiki Base URL
Even though VaultWiki's files must stored in your forum directory, VaultWiki allows Administrators to change the path to the wiki that visitors see. -
+
[H="3"]Wiki Base URL[/H]
Even though VaultWiki's files must stored in your forum directory, VaultWiki allows Administrators to change the URL to the wiki that your visitors will see. -
-
-
For example, normally your wiki URL may look like:
[url]http://www.example.com/forums/wiki[/url] -
+
For example, normally your wiki URL may look like:
[i][noparse]http://www.example.com/forums/wiki[/noparse][/i] -
-
-
This setting allows you to modify the path:
[url]http://www.example.com/wiki[/url] -
+
But you might instead want the following URL:
[i][noparse]http://www.example.com/wiki[/noparse][/i] -
-
-
However, the setting value shouldn't have a trailing slash ([url]http://www.example.com/[/url]) or include parts like /wiki, because both will automatically be added by the script. -
+
To achieve this, you would enter a base URL of:
[i][noparse]http://www.example.com[/noparse][/i] -
-
-
Note this setting only affects the URLs that the wiki creates when linking from page to page. In order for your server to recognize these URLs, you will still need to make changes to your server's .htaccess files, in both the forum and document root directories. -
+
However, the setting value shouldn't have a trailing slash ([i][noparse]http://www.example.com/[/noparse][/i]) or include parts like [I]/wiki[/I], because both will automatically be added by the script. -
-
-
Filename of the Wiki PHP File
Even though the file that servers VaultWiki pages is called showwiki.php, the wiki filename can be changed using this setting. -
+
[template] Warning Box | Note | This setting only affects the HTML output of pages containing wiki URLs. In order for your server to recognize these URLs, you will still need to make changes to your server's [book]Mod Rewrite Configuration[/book].[/template] -
-
-
Never physically rename showwiki.php in your forum directory. Instead, when this setting value changes, you should update your server's .htaccess files as discussed in Configuring .htaccess. -
+
[H="3"]Filename of the Wiki PHP File[/H]
Even though the file that serves VaultWiki pages is called [I]showwiki.php[/I], the file name can be changed using this setting. -
When the Simplify Wiki Links option is also enabled, this setting value will be used as the wiki directory name.
-
-
REQUEST Title Variable -
+
[template]Warning Box | Important | Never physically rename the [I]showwiki.php[/I] file in your forum directory. Instead, when this setting value changes, you should update your server's [book]Mod Rewrite Configuration[/book].[/template]
[H="3"]REQUEST Title Variable[/H] -
The REQUEST Title Variable is the part of the URL that points to the wiki page a visitor is trying to view.
-
-
Consider the URL: [url]http://www.example.com/showwiki.php?title=page[/url] -
+
Consider the URL: [noparse]http://www.example.com/showwiki.php?title=page[/noparse] -
In this case, 'title' is the REQUEST variable that points to a specific page. This setting allows Administrators to change 'title' to something else. -
-
When this setting value changes, you should update your server's .htaccess files as discussed in Configuring .htaccess. -
When the Simplify Wiki Links option is also enabled, this part of the URL will not be visible to users.
-
-
Replace Spaces in URLs -
+
[template]Warning Box | Note | When this setting value changes, you should update your server's [book]Mod Rewrite Configuration[/book].[/template]
[H="3"]Replace Spaces in URLs[/H] -
VaultWiki encodes whitespace characters when creating URLs to wiki pages. This setting allows you to select what character will replace whitespace characters: +, -, or _.
-
-
If you have already created some articles and you change this value, you will need to visit CES VaultWiki -> Wiki URL Manager and click '[Rebuild Page URLs]'. -
+
[template]Warning Box | Note | If you have already created some articles and you change this value, you will need to visit [COLOR="DimGray"]VaultWiki > Wiki URL Manager[/COLOR] and click '[Rebuild Page URLs]'. -
-
-
Enable Link Caching -
+
You should update your server's [book]Mod Rewrite Configuration[/book] if:
[list][*]Your Default Namespace's Title (or its Translations) has spaces in it (optional)
[*]Any Namespace's Custom Path (or its Translations) has spaces in it (required)[/list]
See [help]Adding and Editing Namespaces[/help] for more information on the Namespace settings.[/template]
[h="3"]Simplify Wiki URLs[/h]
Enabling this will leave out the .php extension and title variable from VaultWiki's URLs. Instead URLs will look like: [noparse]http://www.example.com/wiki/Title[/noparse]
[template]Warning Box | Note | When this setting value changes, you should update your server's [BOOK]Mod Rewrite Configuration[/BOOK].[/template]
[h="3"]Enable UTF-8 Support for URLs[/h]
VaultWiki usually attempts to remove foreign language characters from URLs. However, if your board is non-English speaking and already uses UTF-8 encoding, you may opt to allow your language's characters in wiki URLs by turning this feature on.
[template]Warning Box | Note | If you change this value and you have already created some articles that have titles containing foreign language characters, you will need to visit [COLOR="DimGray"]VaultWiki > Wiki URL Manager[/COLOR] and click '[Rebuild Page URLs]'.[/template]
[H="3"]Enable Link Caching[/H] -
VaultWiki attempts to track certain links between wiki pages, like redirects and template inclusions. When this setting is enabled, VaultWiki will track all wiki-related links throughout your forum. -
+
When link caching is disabled, certain Special pages, like [I]Special:Whatlinkshere[/I], will not be available. -
The more posts your forum has, the more intensive tracking this information can be. If you have a forum with a lot of posts, you may consider turning link caching off.
-
-
When link caching is disabled, certain Special pages, like Special:Whatlinkshere, will not be available. -
+
[h="3"]Enable Multi-Language Support[/h]
Multi-Language Support allows your users to post articles in different languages. Users can assign pages to each other as translations.
For example, you might have different versions of a page in English, German, and Russian. If you were reading the English page, you could easily select to view the page in German or Russian.
When Multi-Language Support is enabled, you can also translate certain Namespace fields for each forum language. For more information about editing namespaces, see [help]Adding and Editing Namespaces[/help].
[h="3"]Replace Wiki Tab by URL[/h]
Normally the Wiki Home Page shows a list of all namespaces that the user can view and a search box allowing the user to jump to any wiki page.
[Image] replace-wiki-tab.jpg| center [/Image]
You can define your own page to replace the Wiki Home Page by entering its URL here. Only URLs that would resolve to another wiki page will be accepted.
[template] warning box| Note | Once you enter the URL here, the page will not be accessible from that URL, but from the Wiki Home URL. A 301 permanent redirect will be added at the old location to ensure users find the new location.[/template]