VW4

Running the VaultWiki Install Script

Viewing Source

Once all the VaultWiki files have been successfully uploaded to your web server and the [i]/vault/config.php[/i] file has been setup, you will need to run the VaultWiki Installation Script in order to prepare your database.

[h=2]How to Access the Installer[/h]
Unlike many other forum modifications that you may be used to, the Installer 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 Home tab and click Addons > Install Addon. Select the [i]addon-vaultwiki_stub-INSTALL.xml[/i] file from the VaultWiki ZIP archive, and click "Install Addon."

When the process finishes, in the XenForo Admin Control Panel, access the newly-added Wiki tab and click "Run Install Script."

[h=3]Instructions for XenForo 2.x[/h]
In the XenForo Admin Control Panel, go to Add-ons > Add-ons. In the section Installable Add-ons, locate VaultWiki and click the Install button.

[template] Warning Box | Warning | In XenForo versions 2.0.11 and earlier, do NOT use XenForo 2.x's CLI tool to install 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 installation will fail and could damage your database.

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

[h=3]Instructions for vBulletin[/h]
To start the installation 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 Installer[/h]
The first thing you will see from the install 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 install script and running it without your knowledge.

When you have entered your admin user name and password, hit the "Login" button, and you should be taken to the landing page of the install 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 plug-ins be disabled while running install and upgrade scripts for VaultWiki.[/template]

The first page of the installer script will greet you, while the following steps will prepare your database to run VaultWiki. When you are ready, click "Install" and the installation should proceed automatically.

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

[template]Warning Box | Note | If your installation 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 installation could damage your database.[/template]

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