How to Upgrade Oxygen Feedback to a New Version

Prerequisites

Docker and Docker Compose are required. See the official installation documentation.

Consider the current Linux user to be feedback.

Upgrade

To upgrade Oxygen Feedback Enterprise to a new version on Linux, follow this procedure:

Note:

$OLD_OXYGEN_FEEDBACK_INSTALL_DIR refers to the path of the directory where the current version of Oxygen Feedback Enterprise is installed.

Stop the current Oxygen Feedback instance - Stop the containers running the Oxygen Feedback Service and Oxygen Text Search Service:
```
cd $OLD_OXYGEN_FEEDBACK_INSTALL_DIR
docker compose down
```
Backup the Installation Directory - Create a backup of the current installation directory to ensure you can restore it if needed.
Backup the Databases - Backup the databases used by the Oxygen Feedback Service and Oxygen Text Search Service.
- For MySQL, see: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html.
- For PostgreSQL, see: https://www.postgresql.org/docs/14/app-pg-dumpall.html.
Download the New Version - Create a directory for the new version (e.g. /home/feedback/oxygen-feedback-download) and navigate to it:
```
mkdir -p /home/feedback/oxygen-feedback-download
cd /home/feedback/oxygen-feedback-download
```
Download the latest Oxygen Feedback Enterprise installation kit:
```
wget https://www.oxygenxml.com/InstData/Feedback/oxygen-feedback-enterprise.zip
```
Extract the Installation Kit - Extract the content of the downloaded archive to the user's home directory:
```
unzip oxygen-feedback-enterprise.zip -d /home/feedback
```
The extracted folder (e.g. oxygen-feedback-5.1) becomes the installation directory for the new version:
```
export NEW_OXYGEN_FEEDBACK_INSTALL_DIR=/home/feedback/oxygen-feedback-5.1
sudo chown feedback: $NEW_OXYGEN_FEEDBACK_INSTALL_DIR
```
Update docker-compose.yml - Compare the docker-compose.yml files from the old and new installations. Update the new file based on the configuration in the old file, considering any updates or changes in the new version.
Update Configuration Files - Update the properties files in [NEW_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-home/config using the data from [OLD_OXYGEN_FEEDBACK_INSTALL_DIR]/oxygen-feedback-home/config.

Perform a directory diff comparison to identify changes and merge necessary properties. Refer to the Oxygen Feedback Installation - Step 6: Configure Oxygen Feedback for details.

Copy Data Folders:

Copy the data folder from the old installation:

cp -r $OLD_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-home/data $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-home/data

Copy the workspace folder:

cp -r $OLD_OXYGEN_FEEDBACK_INSTALL_DIR/workspace $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/workspace

Copy License Key - Copy the licensekey.txt file from the old installation:

cp $OLD_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-home/licensekey.txt $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/oxygen-feedback-home/

MySQL JDBC Driver (if applicable) - If using MySQL for the Oxygen Feedback Service, copy the MySQL JDBC driver to the new installation:
```
cp $OLD_OXYGEN_FEEDBACK_INSTALL_DIR/lib/mysql-connector-java*.jar $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/lib/
```
Load Docker Images - Load the Docker images for the Oxygen Feedback Service and Oxygen Text Search Service:
```
cd $NEW_OXYGEN_FEEDBACK_INSTALL_DIR/docker-images
sh load-docker-images.sh
```

Start the New Version - Start Oxygen Feedback Enterprise:

cd $NEW_OXYGEN_FEEDBACK_INSTALL_DIR
docker-compose up -d

Verification

Once the services are up and running, verify that the new version is functioning correctly by accessing the application and checking logs for any errors.