How to change settings by editing the IguanaConfiguration.xml file

Introduction

The IguanaConfiguration.xml file is located in the Iguana IguanaConfigurationRepo directory (<Iguana working directory>/IguanaConfigurationRepo). To change settings simply open the file in a text editor and change the desired settings (you can use TextEdit on Mac if you disable Smart Quotes “Edit>Substitutions>Smart Quotes”). As a precaution it is wise to make a backup copy of the file first.

Note: The IguanaConfigurationRepo directory and the IguanaConfiguration.xml file are not included in the install, instead they are created the first time that you run Iguana.

Tip: If you cannot find the IguanaConfiguration.xml file.

The IguanaConfiguration.xml file is located in IguanaConfigurationRepo directory in the Iguana working directory, which defaults to the Iguana install directory. This means that you have a custom install and the working directory has been changed. You need to look at the –working_dir option for the command_line or command_line_unix entry in the iguana.hdf file. For example:

command_line=C:IguanaAppiguana.exe --working_dir "C:Program FilesiNTERFACEWAREIguanaIguanaDev" -- path quoted because it has spaces
command_line_unix=/home/iguana/iguana_app/iguana --working_dir /home/iguana/dev/

Issue [top]

How to change settings by editing the IguanaConfiguration.xml file

Solution [top]

To change settings:

  1. As a precaution it is wise to make a backup copy of the file first.
  2. Open the file in a text editor.
  3. Change the desired settings.
  4. Save the changes.

The most commonly edited setting are:

  • The web configuration port: The “port” attribute in the <web_config> element
  • The log directory: The “log_directory” attribute in the <log_config> element
  • The plugin port: The “port” attribute in the <rpc_config> element 
    <iguana_config
 encryption_key="Xb9+OWCgTi3NSSUY2UTGJg=="
 major_version="5"
 minor_version="0"
 build_number="7"
 service_log_guid="9B8CD31EE07B29FAE3CCCE25B9503C63"
 startup_clean="true">
 <web_config
  port="8000"
 session_timeout="1200"
 use_https="false"
 server_label="Iguana A Instance"/>
 <email_config
 ...
 </email_config>
 <channel_groupings>
 ...
 </channel_groupings>
 <log_config
 log_purge_time_hour="0"
 log_purge_time_minute="0"
  log_directory="D:/IguanaA/logs/"
 max_log_age_days="60"
 log_sync_type="full"/>
 <rpc_config
  port="7000"/>

How it Works [top]

The IguanaConfiguration.xml file contains the startup settings for iguana, and is read every time an Iguana Server is started. You can edit the settings in this file using a text editor. The most commonly edited settings are for web configuration, log configuration and plugin port.

Editing these settings can be helpful, particularly for customizing production server setup — where you may wish to do things like moving the logs to a separate (fast) disk etc.