Upgrade Procedure

Added in Iguana version 6.1 for Enterprise and Professional tiers only.

Introduction

This page documents how to upgrade an existing Iguana server from a Base tier license (not using encrypted logs) to an Enterprise/Professional license (with encrypted logs enabled).

The process is quite similar to the install process. But instead of installing you must remove the log files and old registration information — before upgrading to an Enterprise/Professional license.

We strongly recommend that you review the other documents in this section before performing this upgrade procedure.

Upgrade Procedure [top]

Follow these steps:

  1. Prerequisite: The server must be running Iguana version 6.1 or higher.
  2. Stop Iguana.

    Stop the Iguana service (Windows) or daemon (linux/mac), or exit the command/terminal window if you are running it as a process.

  3. Backup the logs directory.

    Be sure you follow proper backup procedures so the historical log files will be available if you need them in the future.

  4. Delete the logs directory.

    Iguana will re-create the logs directory on startup if it does not exist.
    Note: You can also keep the directory so long as it is empty — usually deleting the directory is easier (than deleting all the log files in the directory).

  5. Delete the IguanaLicense file from the Iguana working directory.

    This file contains your license code. To initialize encrypted logs we need to upgrade the license at startup — which only happens when this file (and hence all license information) is removed. If you attempt to upgrade to an Enterprise/Professional license while Iguana is running it will fail — and give an error telling you to follow this process.

  6. Start the Iguana Server.
  7. Register Iguana.
    • Register Iguana – Step 3: Omit step 3do not use a temporary license
      Note: If you do choose a temporary license you will need to repeat the upgrade process
    • Register Iguana – Step 4: Click the Retrieve License button
    • Register Iguana – Step 4: Activate or transfer an Enterprise or Professional license
    • Register Iguana – Step 4: Click Activate inside Iguana
      Note: You can always copy/paste the license code manually if necessary
    • Registration should now be complete
  8. Now you will need to create the Log Encryption Locker file.

    Tip: This is a one-time process when you Register an Enterprise/Professional license, this occurs when you do one of the following:

    • A fresh install and choose an Enterprise/Professional license
    • An upgrade to an Enterprise/Professional license
    • If you change from one Enterprise/Professional license to a different Enterprise/Professional license.
      Note: This follows the same process as an upgrade
  9. You screen should now look similar to this:
  10. Click the Create Log Encryption Locker button.
  11. In the Initialize Log Encryption Locker screen:
    • If you wish to unlock an existing (shared) locker go directly to step 8
    • Choose the Log Locker Directory — default is the Iguana working directory
      Note: This can be changed at Iguana startup, but not in the Log Encryption settings
    • Enter your Log Locker Password
      Note: This can be changed at any time in the Iguana Log Encryption settings
    • Optional: Select Enable Auto-unlock
      Note: This can be changed at any time in the Iguana Log Encryption settings
    • Click Create

      Warning: It is critical not to forget the encryption locker password!

      If the locker password is lost then you will not be able to open the locker file — which means you will lose access to all historical (encrypted) logs. There is no alternative method to recover the logs.

      We recommend storing the password securely in atleast two places, for example: One encrypted copy on a different physical device from the Iguana Server, and a second hard copy in a safe.

  12. Alternatively you can unlock an existing (shared) locker file:
    Note: To understand how this works, see Sharing a Locker File

    • Omit this step if you performed step 7
    • Copy the existing (shared) locker file to the Log Locker Directory
      Note
      : You may also copy the associated unlocker file (if it exists), but it is not necessary as you can easily enable Auto-Unlock in the Log Encryption settings
    • Get the password for the existing (shared) locker file
    • Choose the Unlock Existing tab
    • Choose the Log Locker Directory that you copied the shared locker file to
      Note: This can be changed at Iguana startup, but not in the Log Encryption settings
    • Enter your Log Locker Password
      Note: This can be changed at any time in the Iguana Log Encryption settings
    • Click Unlock
  13. Optional: Select Enable Auto-unlock in the Iguana Log Encryption settings
  14. The upgrade process is now complete.

More Information [top]