1. VW4
2. Updating the VaultWiki Scripts on your Web Server

Printable Version

Before Uploading: Disable VaultWiki

Before uploading your new VaultWiki files, you should disable your existing VaultWiki installation. This will prevent errors and messages and caused when the upload is still in progress.

• In vBulletin, from your AdminCP, go to Plugins & Products > Product Manager, and find "VaultWiki" in the list. Using the drop-down menu, select "Disable."
  
• In XenForo, from your Admin Control Panel, go to Add-ons > List Add-ons, and find "VaultWiki" in the list. Using the "Controls" drop-down menu, select "Disable."

Extract and Upload

Before uploading the VaultWiki files to your web server, you first need to extract them from the package.

First open the folder on your computer where you saved the VaultWiki package and double-click the VaultWiki package. This should allow you to see the contents of the package.

Open the /upload folder to gain access to the actual VaultWiki files that need to be uploaded. The uploading process should be familiar to anyone who has updated their forum software or other modifications before.

Using an FTP client or other method, navigate to the same remote directory that contains your existing forum software installation. If you are using an FTP client or other method that supports drag-and-drop uploading, simply select all of the sub-folders and files in this /upload directory, and drag them into the appropriate pane in your application to initiate the upload.

If the client does not support drag-and-drop uploads, you will likely first have to extract or drag the files onto your local hard disk. Please refer to your application's Help content if you are unsure how to perform an upload.

Note:

Make sure that you choose to overwrite ALL existing VaultWiki files with the files in the package. Some clients have options allowing you to only overwrite if timestamps are newer; avoid using this option. The timestamps in the package correspond to our times on our servers, and these might be earlier than uploads or edits you may have performed on your server, or for servers in different time zones.

After Uploading: 4.0.x to 4.1.x Considerations

If you're upgrading from the 4.0.x branch to the 4.1.x branch, on some platforms you may notice that there is no /vault directory in the new version.

Warning:

Do NOT remove your existing /vault directory until you have completed the upgrade process to 4.1.x and your AdminCP reflects the new version. Removing the directory prematurely could remove files that your forum is still using, resulting in fatal errors on most forum pages that can only be resolved by reuploading the old directory or disabling the forum's add-on system via the forum's config.php file. Since VaultWiki must be enabled in order to upgrade, you could create a situation where you are unable to upgrade at all, if you don't have a backup of the files.

4.0.x to 4.1.x Consideration for XenForo 1.x

If you are upgrading VaultWiki to 4.1.x for the first time on XenForo 1.x, also note that the location of the /vault/config.php file has changed to /library/vw/config.php. If you made customizations to your file, you will need to apply those changes to the one at the new location.

Your old /vault/config.php file may contain lines related to a VW_DEPOT_PATH constant. In order to complete the upgrade, you will need to remove these lines from the file, or update the path in both locations to be a /path/to/library/vw.

After Uploading: Re-enable VaultWiki

If your pre-upgrade VaultWiki version is 4.0.0 Beta 6 or higher, you should re-enable your existing VaultWiki installation. If VaultWiki is still disabled, you may not be able to access the upgrade script on some forum platforms.

• In vBulletin, from your AdminCP, go to Plugins & Products > Product Manager, and find "VaultWiki" in the list. Using the drop-down menu, select "Enable."
  
• In XenForo, from your Admin Control Panel, go to Add-ons > List Add-ons, and find "VaultWiki" in the list. Using the "Controls" drop-down menu, select "Enable."

Warning:

If you currently have VaultWiki version 4.0.0 Beta 5 or lower installed and you wish to upgrade to a newer version, then VaultWiki MUST be disabled rather than enabled. Leaving VaultWiki enabled while attempting an upgrade from early versions can trash your wiki database and config files. For these versions, we highly recommend opting for an Upgrade Service to save yourself from any headaches.