Software Update

Update ManualWorks to a new version in the <Admin | Software Update> menu.

Preparing the Software Update

When the ManualWorks Server Can Connect to the Internet

Check whether an update is available and download the required installation file as follows.

When you check for and download a software update, the server ID, the installed product version, the major version, and the locale are sent to the ManualWorks update server.

  1. Go to the <Admin | Software Update> menu.

  2. Click the <Check for Updates> link.

  3. If an update is available, the 1new version information and the <2Download Update> link appear.

    • Click the <3View Release Note> link to see what changed.

  4. Click the <2Download Update> link to download the files needed for the update.

Downloading the software update

Downloading the software update

If you decide not to update after the installation file is downloaded, click the <4Cancel> link.

The checksum of the installation file downloaded from the update server is checked automatically. If it does not match, the file is deleted.

Software update ready

Software update ready

When the ManualWorks Server Cannot Connect to the Internet

If the server where ManualWorks is installed is not connected to the internet, it cannot download the installation file. In that case, upload the installation file yourself as follows.

  1. Download the installation file from the 3Rabbitz website. We recommend checking the checksum of the installation file.

  2. Go to the <Admin | Software Update> menu.

  3. Click the <Check for Updates> link.

  4. Click the <1Upload File> link, and upload the installation file you downloaded.

Uploading the installation file

Uploading the installation file

The <Upload File> link appears when ManualWorks cannot connect to the update server. If the link does not appear, see Updating the Software Manually.

The installation file name must start with 3rabbitz and end with .tar.gz or .zip. Do not rename the downloaded installation file. If the name does not match, you are notified right away when you upload it, and the file is not accepted.

Restarting ManualWorks

After the download finishes, restart ManualWorks to update the software automatically. The update is applied while ManualWorks is stopping, so if you kill the process, the update is not applied. Restart ManualWorks only after it has stopped completely.

For details, see Stopping ManualWorks and Starting ManualWorks.

The update replaces the web/WEB-INF/web.xml file with a new one. If you have customized this file, keep the existing file by running set-preference -name KEEP_WEB_XML -value true in the Console before the update.

When the License Key Version Does Not Match

For a major update, you must update the license key first. If less than a year has passed since purchase, we will issue a new license key. Send your server ID to the following email address.

support@3rabbitz.com

If more than a year has passed since purchase, you must purchase a software update.

Behind a Firewall

If ManualWorks is installed behind a firewall, open the following addresses so that it can connect to the ManualWorks update server.