How to Upgrade Oxygen Feedback to a New Version

Stop the current Oxygen Feedback instance. For example:

Run $OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-2.1/bin/stop.sh

Make a backup of the database used in your current Oxygen Feedback installation.

For MySQL, see: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html.
For PostgreSQL, see: https://www.postgresql.org/docs/9.2/app-pg-dumpall.html.

Download the latest Oxygen Feedback Enterprise installation kit.

Create an installation directory (subsequently referred to as NEW_OXYGEN_FEEDBACK_INSTALL_DIR) and unzip the downloaded kit to this new directory. The application files are stored in this directory.

Sample code to create the installation directory:

export NEW_OXYGEN_FEEDBACK_INSTALL_DIR=/home/feedback/oxygen-feedback-upgraded
sudo mkdir $NEW_OXYGEN_FEEDBACK_INSTALL_DIR
sudo chown feedback: $NEW_OXYGEN_FEEDBACK_INSTALL_DIR

Sample code to extract the archive content:

cd $NEW_OXYGEN_FEEDBACK_INSTALL_DIR
# Download new version of Oxygen Feedback and save it to $NEW_OXYGEN_FEEDBACK_INSTALL_DIR
wget https://www.oxygenxml.com/InstData/Feedback/oxygen-feedback-enterprise.zip
# Unzip downloaded file
unzip oxygen-feedback-enterprise.zip

Step Result: The archive content is extracted into a new directory (for example, named oxygen-feedback-3.0), so the path becomes: [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0.

Configure the Application Properties for Oxygen Feedback Service.

Remember:

By default, in Oxygen Feedback 2.1, the Feedback Home Directory was configured to point to the current installation directory. The home directory stores the configuration and other data. You cannot set a custom home directory, other than the current installation directory.

Depending on whether or not you have a custom Feedback Home Directory configured in your previous installation, choose one of the following procedures:
1. [Option 1] If you already have an external Feedback Home Directory configured:
  1. Make a backup copy of the current home directory:
```
cp -a ${OXYGEN_FEEDBACK_HOME_DIR} ${OXYGEN_FEEDBACK_HOME_DIR}.bak
```
  2. Update the properties files from [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home/config using the data available in [OXYGEN_FEEDBACK_HOME_DIR]/config. If the structure was modified, also update the new property values.
    Tip: You could perform a directory diff comparison between [OXYGEN_FEEDBACK_HOME_DIR]/config and [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home/config to determine the changes in the structure. You should also fill in the newly added properties in the latest version (see Oxygen Feedback Installation - Step 6: Configure Oxygen Feedback).
  3. Copy the [OXYGEN_FEEDBACK_HOME_DIR]/data directory to [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home/data.
  4. Copy the [OXYGEN_FEEDBACK_HOME_DIR]/licensekey.txt file from the old installation to the [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home directory.
2. [Option 2] If you have not configured a custom Feedback Home Directory in the old installation:
  1. Update the [[NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home/config files based on your configuration from your previous installation. Perform a directory diff comparison between [OXYGEN_FEEDBACK_HOME_DIR]/config and [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home/config to determine the changes.
  2. Fill in the newly added properties in the latest version (see Oxygen Feedback Installation - Step 6: Configure Oxygen Feedback).
  3. Copy the [OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-2.1/data directory (old installation) to [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home/data.
  4. Copy the licensekey.txt file from the old installation to the [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/oxygen-feedback-home directory.
If you are using MySQL for Oxygen Feedback Service:
1. Copy the MySQL JDBC driver from the old installation to [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/lib or download a version of MySQL and add it to [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-3.0/lib (see How to Set Up the Database).
2. Edit the $OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-3.0/docker-compose.yml Compose file and add the following volume to the Oxygen Feedback Service container
```
services:
  feedback-service:
    # [...]  
    volumes:  
      - type: bind
        source: ./lib/mysql-connector-java.jar
        target: /oxygen-feedback-enterprise/lib/mysql-connector-java.jar
```

Load docker images.

The Oxygen Feedback Enterprise distribution contains two docker images running the following services each in its own container:

Oxygen Feedback Service
Oxygen Text Search Service

Run load-docker-images.sh (e.g. $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-3.0/docker-images/load-docker-images.sh) to load Oxygen Feedback Service and Oxygen Text Search Service docker images in your local environment.

cd $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-3.0/docker-images
sh load-docker-images.sh

Configure docker-compose.yml.

Edit the $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-3.0/docker-compose.yml Compose file to configure the docker containers for following services:

Oxygen Feedback Service
Oxygen Text Search Service

See the Configure docker-compose.yml step in the Installation procedure for more details.

Start Oxygen Feedback Enterprise. For example:

cd $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-3.0
docker-compose up -d

How to Upgrade Oxygen Feedback to a New Version

Prerequisites

Upgrade