WoodWing Help Center

Upgrading Elvis 5

 

Upgrading Elvis 5

When upgrading an existing version of Elvis 5 (Server and client) to a newer version of Elvis 5, the Server and client application is upgraded while your data, Server configuration and log files are left in place.

The process of upgrading is as follows:

  1. Creating a backup of the existing installation
  2. Stop your current server
  3. Installing Elvis Server
  4. Configuring Elvis Server
  5. Reviewing optional steps for the Server
  6. Starting Elvis Server
  7. Installing the Desktop client
  8. Reviewing optional steps for the Desktop client
  9. Testing Elvis Server

Before you start

Before you start the upgrading process, please familiarize yourself with the changes that were made in the various Elvis releases by reading through the Release Notes.

Starting with Elvis 5.14, various changes were made to increase the stability of Elvis Server which may result in having to configure the server differently than you were used to.

1. Creating a backup of the existing installation

Make sure you have a recent backup of your current environment.

Because all Elvis data is stored on the file system, all data in the following Elvis Server folder locations should be backed up:

  • Elvis Hot Data
  • Elvis Shared Data
  • Config

2. Stop your current server

Stop your current Elvis Server from running.

3. Installing Elvis Server

Download the installer from the software download page, run it and follow this instructions on screen. It will automatically detect the existing version and will replace all application files. Your data, configuration and log files will not be touched.

4. Configuring Elvis Server

During the Server installation, a folder named clean-example-config-x.x.x is created in the main Config folder. It contains a clean copy of the latest configuration files.

Use it as a reference for any new configuration options that are available which you might want to make use of.

5. Reviewing optional steps for the Server

Depending on the version you are upgrading from, some additional steps may be required. Review the below information and implement where necessary. Start by the version that you are upgrading from and then verify the information for each newer version.

When launching a Desktop client after a Server upgrade, a new version is automatically detected and an upgrade is offered.

6. Starting Elvis Server

At this point, Elvis Server is ready to be started.

Important: As part of the upgrade process, Elvis Server will automatically update the index. Depending on the size of the index, this can either take a few moments or it can take some time. Do not restart Elvis Server until this process is finished. Use the Paramedic page of Elvis Server (access Elvis Server > Support Tools > Elasticsearch > Paramedic or use URL localhost:9200/_plugin/paramedic/) to monitor the progress.

7. Installing the Desktop client

Desktop client upgrade message

Alternatively users can go to the client install page on the server, which will also detect the newer client version and will allow upgrading.

Desktop client upgrade message on the Server

Note: If error occurs during installation, see Known issues - client install.

8. Reviewing optional steps for the Desktop client

Depending on the version you are upgrading from, some additional steps may be required. Review the below information and implement where necessary. Start by the version that you are upgrading from and then verify the information for each newer version.

9. Testing Elvis Server

Verify that Elvis Server is working properly by using the Desktop client or the Pro Client. Perform tasks such as uploading some files, searching for them, downloading or sharing them, or any other tasks that are part of your daily workflow.

Document history

  • 27 March 2017: Added a 'Before you start' section.
  • 27 March 2017: Added step 'Starting Elvis Server'.
  • 7 February 2017: Added instructions for upgrading Elvis versions 5.0 – 5.20 that have been upgraded from Elvis 4.
  • 17 January 2017: Added instructions for using the 'Recover misplaced asset files' tool.
  • 13 December 2016: Added instructions for upgrading from Elvis 5.10 to Elvis 5.11 - 5.18.
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

1 Comments

  • 0
    Avatar
    Erik Korver

    Please also pay attention to compare and possibly upgrade your active scheduled and action plugins. You can compare them with the latest available versions inside the /plugins/samples/... folder.

Please sign in to leave a comment.