NXLog Documentation

Upgrading NXLog Manager

Upgrading from earlier versions of NXLog Manager will require changes to the database structure. To complete the upgrade it is required to stop the NXLog Manager service before proceeding.

On SysV Init based systems
# service nxlog-manager stop
On systemd based systems
# systemctl stop nxlog-manager
It is always advisable and good practice to create a backup before upgrading. This enables the process to be rolled back if something goes wrong. Use mysqldump or phpMyAdmin to backup MySQL/MariaDB. It is also recommended to make a backup of the configuration files.

Upgrade to version 4.0.6223 or later

Follow this procedure if you are running a version of NXLog Manager earlier than 4.0.6223, and you are planning to upgrade to version 4.0.6223 or later, but not to version 5x.

After stopping the NXLog Manager service, upgrade NXLog Manager but do not start the service. Navigate to /opt/nxlog-manager/db_init/upgrade/ and execute the command:

# mysql -u root nxlog-manager4 < upgrade_to_6223.sql

The upgraded version of NXLog Manager service can now be started.

Upgrade from Version 4.x to Version 5.x

Follow this procedure, to upgrade from version 4 of NXLog Manager to version 5.x.

After stopping the NXLog Manager service, upgrade NXLog Manager but do not start the service. The upgraded NXLog Manager requires first a database initialization. Do not start the NXLog Manager service as part of the initialization. After initializing the database, navigate to /opt/nxlog-manager/db_init/upgrade/ and execute the command:

# mysql -u root -p < upgrade_v4_to_v5.sql

The command will copy all the relevant information from the earlier version of NXLog Manager database to the new database without altering the old database. The upgraded version of NXLog Manager service can now be started.

Upgrade Version 5.x to Later 5.x version

Follow this procedure, to upgrade version 5.x installation of NXLog Manager.

After stopping the NXLog Manager service, upgrade the NXLog Manager packages through dpkg/apt or rpm/yum and then start the service.

On SysV Init based systems
# service nxlog-manager start
On systemd based systems
# systemctl start nxlog-manager

Upgrade the Docker Application

Upgrading NXLog Manager as a Docker application can be successfully done in case of minor changes between versions. For example, the version 5.4 can be upgraded to 5.5 but not 6.0.

Upgrading NXLog Manager migrates existing settings to the new version. Nonetheless, it is highly recommended to create a database backup before upgrading.

The following steps should be performed to upgrade NXLog Manager as a Docker application.

  1. Docker containers should be stopped with the following command in the NXLog Manager directory:

    $ docker-compose down
  2. The archive with the new version of NXLog Manager should be unpacked with the following command:

    $ tar zxf nxlog-manager-X.X.XXXX-docker.tar.gz
  3. The .deb package from the unpacked archive should be put to the NXLog Manager directory and the existing package file should be deleted.

  4. Docker images and containers should be built and started with the following command in the NXLog Manager directory:

    $ docker-compose up --build -d