Tutorial: Iguana production server install

This post was originally written for Iguana 5 so it contains version 5 screenshots, and may contain out of date references.

In this tutorial you will learn how to do a basic Iguana Production Server install, following our recommended Best Practice Production Deployment for Iguana.

This tutorial makes these assumptions:

  1. That you are using Windows.
  2. You wish to install the current release of Iguana.
  3. There is only one instance of Iguana installed on the server.

This process can easily be adapted for other operating systems, multiple instances, and modifying an existing install (see notes and tips in the instructions).

Obviously there is no single solution for all scenarios, so please contact support at support@interfaceware.com if you need help adapting this procedure for your installation.

Tutorial Instructions [top]

  1. For this tutorial we assume that Iguana 5.6.20 is the current release of Iguana.
  2. Make sure you use an account with Administrator privileges.
  3. Create the directories required to install Iguana:
    1. Create a versioned install directory C:\Iguana-5-6-20\
      Note: The directory name is in the format C:\Iguana-<version number>\, i.e., for 6.2.10 use C:\Iguana-6-2-10\
    2. Create the configuration directory C:\IguanaConfig\
    3. Create the logs directory D:\IguanaLogs\

      Note: Iguana can run from any location (with write permission).

      For Windows a “standard” install is in C:\Program Files (as performed by the automated installer), but you can use a different directory if desired (as we do in this tutorial), we suggest you discuss a suitable location with your system administrator.

      For Linux, Unix and Mac the simplest place to install is under your home directory, though your administrator may prefer that you install in a different directory.

      Tip: We recommend that the logs are placed on a disk/device with the fastest possible write time (for example a dedicated disk on the local machine). This is particularly important for production servers that are processing heavy transaction loads. You can discuss a suitable location with your system administrator.

      See Log Configuration and Performance for more information.

  4. Download the latest zip file manual installer version of Iguana:
    1. Click the Other downloads are available below link on our iNTERFACEWARE Downloads page.
    2. From Upgrading Iguana? choose either the 32 or 64 bit manual installer to match your operating system:

      Tip: Downloads for other operating systems are available from the iguana directory on our download site: http://dl.interfaceware.com/iguana/, for more information see this page: Download other install files.

  5. Extract the files into the new created install directory:
    1. Open the install zip (double click on it), and then select all the files (Ctrl+A) and drag them into the install directory C:\Iguana-5-6-20\
  6. Update the Iguana Service configuration details in the iguana_service.hdf file:
    1. Append --working_dir C:\IguanaConfig\ argument to the command_line=iguana.exe entry.
      The result should look like this:

      application{
         service_kill_timeout = 500000 
         service_display_name=iNTERFACEWARE Iguana
         service_name=Iguana
         service_description=HL7 Integration Engine
         command_line=iguana.exe --working_dir C:\IguanaConfig\
         command_line_unix=./iguana
         path_registry_entry_win32 = SYSTEM\CurrentControlSet\Control\Session Manager\Environment
      }

      Note: If your working directory path contains spaces (like C:\Program Files\iNTERFACEWARE\Config\) you will need to enclose it in quotes, like this:

      application{
         service_kill_timeout = 500000 
         service_display_name=iNTERFACEWARE Iguana
         service_name=Iguana
         service_description=HL7 Integration Engine
         command_line=iguana.exe --working_dir "C:\Program Files\iNTERFACEWARE\Config\"
         command_line_unix=./iguana
         path_registry_entry_win32 = SYSTEM\CurrentControlSet\Control\Session Manager\Environment
      }

      Note: For Linux, Unix and Mac you need to append --working_dir C:\IguanaConfig\ argument to the command_line_unix=iguana.exe entry instead.

      Tip: You may want also to change the display_name and/or the service_name to match the version number of Iguana, to make it more obvious which version the service is running.

      The result would look like something this:

      application{
         service_kill_timeout = 500000 
         service_display_name=iNTERFACEWARE Iguana 5.6.20
         service_name=Iguana_5_6_20
         service_description=HL7 Integration Engine
         command_line=iguana.exe --working_dir C:\IguanaConfig\
         command_line_unix=./iguana
         path_registry_entry_win32 = SYSTEM\CurrentControlSet\Control\Session Manager\Environment
      }
  7. Install the Iguana Service:
    1. Run the command line console (cmd) as Administrator.
    2. Change to install directory, run the command: cd C:\Iguana-5-6-20\
    3. Install the service, run the command: iguana_service --install
    4. The Iguana service is created with the display name iNTERFACEWARE Iguana.
      As you can see in Windows Services:

      Tip: The Service name and the Display name can also be specified in the iguana_service.hdf file. This should be done before you install the service.

      If you decide to change the Service name after you have to installed the service, then you will need to uninstall the service first (before changing the service name) by running the command iguana_service --uninstall

  8. If you are modifying an existing server you will need to move the configuration files IguanaConfiguration.xml and vcs_repo.sqlite to the configuration directory C:\IguanaConfig\

    Note: This is not required with a new install as these files will automatically be created (in the configuration directory) the first time we start the Iguana Service.

  9. Change the log directory:
    1. Start and stop the iguana service (to create the Iguana configuration files).
    2. Edit C:\IguanaConfig\IguanaConfiguration.xml and change the log_directory entry in the log_config section to D:\IguanaLogs\
      The log_config section should now look like this:

         <log_config
            log_purge_time_hour="0"
            log_purge_time_minute="0"
            log_directory="D:\IguanaLogs\"
            max_log_age_days="60"
            log_sync_type="off"/>
  10. Start the Iguana service again.
  11. And that’s all there is to it, you’re done!

Multiple Server Instances [top]

Creating multiple Iguana Server instances on the same machine is simple, there are couple of extra steps.

  1. Create separate install directories for each instance:
    1. We will call our instances Iguana_prod1 and Iguana_prod2.
    2. Create two install directories: C:\Iguana_prod1-5-6-20\ and C:\Iguana_prod1-5-6-20\
    3. Create two configuration directories: C:\Iguana_prod1-Config\ and C:\Iguana_prod2-Config\
    4. Create two logs directories: D:\Iguana_prod1-Logs\ and D:\Iguana_prod2-Logs\

      Tip: It is possible for multiple instances to share the same application files. This approach can be useful if you wish ensure that all instances will be using the same version of Iguana. It also simplifies the upgrade process as you only need to upgrade a single shared installation directory.

      See this page for more information: Multiple instances of Iguana using a single install folder.

  2. Repeat the Tutorial Instructions in the previous section for each instance that you are creating, using the directories created for each instance.
  3. When you update the service details (step 6) you also need to use a different Working Directory, Service name and Display name for each instance:
    1. Update the command_line, service_name and the service_display_name in the iguana_service.hdf file:
      The results should look something like this:

      application{
         service_kill_timeout = 500000 
         service_display_name=iNTERFACEWARE Iguana_prod1
         service_name=Iguana_prod1
         service_description=HL7 Integration Engine
         command_line=iguana.exe --working_dir C:\Iguana_prod1-Config\
         command_line_unix=./iguana
         path_registry_entry_win32 = SYSTEM\CurrentControlSet\Control\Session Manager\Environment
      }
      application{
         service_kill_timeout = 500000 
         service_display_name=iNTERFACEWARE Iguana_prod2
         service_name=Iguana_prod2
         service_description=HL7 Integration Engine
         command_line=iguana.exe --working_dir C:\Iguana_prod2-Config\
         command_line_unix=./iguana
         path_registry_entry_win32 = SYSTEM\CurrentControlSet\Control\Session Manager\Environment
      }
  4. When you change the log directory (step 9) you also need to change the default web server port for one of the servers.
    Note: The default Iguana web port is 6543 so you need to change one of them to prevent a conflict.

    1. Choose an unused port number to use, as an example we will use 6544.
    2. Update the port in the web_config section of the IguanaConfiguration.xml file.
      The web_config section should now look something like this:

       <web_config
       port="6544"
       session_timeout="1200"
       use_https="false"/>

More Information [top]

Leave A Comment?