VW4

Running the VaultWiki Upgrade Script

Viewing Source

With the newest VaultWiki files uploaded to your web server, you can now proceed to run the upgrade script.

[h=2]How to Access the Upgrade System[/h]
Unlike many other forum modifications, the upgrader runs as a separate PHP script using your web browser. These instructions vary slightly for each forum software you may be using with VaultWiki.

[H="3"]Instructions for XenForo 1.x[/H]
In the XenForo Admin Control Panel, go to the Wiki tab and click Maintenance > Run Upgrade Script. If you cannot find this menu item, then the VaultWiki add-on is currently disabled in XenForo's "List Add-ons" page. Re-enable VaultWiki to access its admin controls, then go to the Wiki tab and click Maintenance > Run Upgrade Script.



[H="3"]Instructions for XenForo 2.x[/H]
In the XenForo Admin Control Panel, go to Add-ons > Add-ons. In the sections Upgradeable Add-ons, locate VaultWiki and click the Upgrade button.

[template]Warning Box|Warning|In XenForo versions 2.0.11 and earlier, do NOT use XenForo 2.x's CLI tool to upgrade VaultWiki via the command line. Due to [URL="https://xenforo.com/community/threads/cli-command-should-set-non-zero-return-value-on-error.154923/"]a bug in XenForo's CLI script[/URL], the upgrade could fail and damage your database.

In XenForo versions 2.0.12 and later, you may use XenForo 2.x's CLI tool to upgrade VaultWiki via the command line.[/template]

[h=3]Instructions for vBulletin[/h]
To start the upgrade process, open your browser and visit the HTTP address of your forum directory, followed by [i]/vault/install/index.php[/i]

[h=2]Run the Upgrade Script[/h]
The first thing you will see from the upgrade script is a log-in prompt, asking you to log into your forum's admin area. This is done to prevent other users from accidentally stumbling across the upgrade script and running it without your knowledge.

When you have entered your forum user name and password, hit the "Login" button, and you will be taken to the landing page of the upgrade script.

[template]Warning Box | Warning | Certain browser plug-ins can have an adverse effect on the VaultWiki installation and upgrade scripts. We recommend that all browser plugins be disabled while running installation and upgrade scripts for VaultWiki.[/template]

The first page of the upgrade script will greet you, while the following steps will update your database to run the new version of VaultWiki. Click "Upgrade" to begin and the upgrade should proceed automatically.

If a prompt appears, fill in any additional information as needed. Otherwise, the automated process should continue unhindered until the upgrade is complete.

[template]Warning Box | Note | If your upgrade is not successful or seems to hang at any point, please contact VaultWiki support before making another attempt or trying to reinstall VaultWiki. Trying to install or upgrade from an incomplete VaultWiki upgrade could damage your database.[/template]

When the upgrade is complete, VaultWiki will be automatically re-enabled, you will be taken to VaultWiki's Admin Panel.
3,082 characters
Welcome to VaultWiki.org, home of the wiki add-on for vBulletin and XenForo!
