Backup and restore Iguana


This page describes how to backup and restore an Iguana Server. Please pay careful attention.

Note: If you’re used to backing up an Iguana 5 server there are some changes:

  • We changed from using a Fossil repository to using a Git repository, so you need to back up the Git repository directory instead of the Fossil file.
  • We moved the configuration file (IguanaConfiguration.xml) into the Git repository, so you no longer need to back it up separately

Backup Procedure [top]

Backup the following items:

  1. Git Repository Directory: <working directory>/IguanaMainRepo
  2. Environment File: <working directory>/IguanaEnv.txt
  3. Log Files: <log directory>/log<YYYMMDD>.log
    • Log backup must not be run when the logs are being purged, this time can be found in the log settings.
  4. Databases: All databases that are used in your channels.
  5. Sample Data Files (optional): backup the sample data for channels, located in <working directory>data.

It’s important that your backup process does not backup these files:

  • <log directory>/logindex*.*
  • <log directory>/logmeta*.*

These files are index files for the logs which Iguana can regenerate from scratch from the *.log files. There is no benefit in backing them up. If you do back them up it can stop Iguana from functioning since the backup process can lock these files so that you will see this error.

Restore Procedure [top]

Follow these steps:

  1. Stop the iNTERFACEWARE Iguana service (if exists and is running)
  2. Install or reinstall Iguana .
  3. If you need a new license code follow the procedure for transferring a license to another computer
  4. Replace the default Git Repository Directory (<working directory>/IguanaMainRepo) with your saved backup copy. (backup the existing one first if it is a different installation than the one you are restoring from and you don’t want to lose the channels/configuration)
  5. Delete any existing <working directory>/IguanaConfigurationRepo, <working directory>/edit folders that may be present.
  6. Start/stop Iguana in safe mode  (to clone the new IguanaConfigurationRepo from the replaced IguanaMainRepo)
    • cd C:Program Files<install directory>
      iguana --run --safe_mode
  7. Edit<working_directory>/IguanaConfigurationRepo/IguanaConfiguration.xml change any instance of StartAutomatically or start_automatically from true to false. If this is a different install directory from the one you are restoring from, you need to update the log_directory entry as well to match this new install location.
  8. Restore all other backed up files:
    1. <YYYMMDD>.log
    2. All databases that are used by your channels
    3. Optionally sample data for channels
  9. Test channels by starting each one manually.


  • If your backup (or antivirus) software locks the index files for over 30 minutes, this error is generated and all channels will be stopped.
  • Database backup and restore procedures will differ, speak to whoever is responsible for the databases you are using.
  • This process can also be used to duplicate a server on another machine, which is useful for development purposes:
    • To install in a different directory you must update the log_directory entry in IguanaConfigurationRepo/IguanaConfiguration.xml to match.
    • Step 6 backing up the sample data is particularly useful if you are copying a development server.
  • The *.log files are designed to be backup friendly – they are append only. However ensure that your backup software does not exclusively lock these files.

More information [top]

Leave A Comment?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.