How to backup and restore Iguana

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

Backup Procedure

Backup the following Iguana files:

  1. <working directory>\IguanaConfiguration.xml
  2. <working directory>\vcs_repo.sqlite
  3. <working directory>\IguanaEnv.txt
  4. <log directory>\log\<YYYMMDD>.log
  5. All VMD files that are used by Legacy components in your channels.
    • Legacy components are: From Database, To Database and Legacy Filter components
    • All Translator component VMDs are stored in Fossil (vcs_repo.sqlite) and will be recreated automatically
  6. All databases that are used in your channels.
  7. Optional: backup the sample data for channels, located in <install dir>\data.

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

  • <log directory>\log\index\*.*
  • <log directory>\log\meta\*.*

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

Follow these steps:

  1. Install or reinstall Iguana
    • To install in a different directory you must update the log_directory entry in IguanaConfiguration.xml to match.
  2. If you need a new license code follow the procedure for transferring a license to another computer
  3. Stop the iNTERFACEWARE Iguana service
  4. Replace the default IguanaConfiguration.xml file with your saved backup copy 
  5. Edit IguanaConfiguration.xml change any instance of StartAutomatically or start_automatically from true to false
  6. Restore all other backed up files:
    1. vcs_repo.sqlite 
    2. <YYYMMDD>.log
    3. All VMD files that are used by Legacy components in your channels
    4. All databases that are used by your channels
    5. Optionally sample data for channels
  7. Test channels by starting each one manually.
  8. Once everything works configure the channels to start automatically, or simply reverse the edits made in step 5.

Notes

  • 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 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.

One Comment

  1. Pingback: Top Support Questions of March 2015 - iNTERFACEWARE Inc.

Leave A Comment?