Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: fixed typos in H3 titles



Windows

For a new installation from a ZIP file, do the following:

  1. Unzip the contents of the ZIP file. Wherever this file in unzipped is where Ignition will be installed so be sure to unzip this file in a suitable location. For this example, I placed my zip file contents in "C:\Program Files\Inductive Automation\Ignition\" which is the default Windows installation directory for Ignition.
  2. Once your file contents are unzipped in a suitable location, run the executable file named install-ignition.bat to install the Windows service like below:



  3. Similarly, run the executable file named start-ignition.bat to start the Ignition service. 
  4. Navigate to the Gateway's web interface ( http://localhost:8088) to start the commissioning process. If any errors occur during startup, they will be logged to logs/wrapper.log 



On_this_page



Upgrading an Existing Windows Installation

If you are upgrading from a preexisting installation, follow these steps:

  1. Take a Gateway backup from the running system and store in a safe location.
  2. Stop Ignition by runing the stop-ignition.bat file located in the Ignition installation directory. 



  3. Delete both the lib and webserver\webapps folders.
  4. Unzip the ZIP installer for the version you're upgrade to into the current folder and allow files to be overwritten.
  5. Unzip the new jre-win runtime in lib\runtime folder. 
  6. If this is a major version upgrade (such as 8.0 to 8.1) then the data/ignition.conf file may have changed. If this is a minor version upgrade (8.0.1 to 8.0.2) then skip to step 8.

  7. To upgrade the ignition.conf file for a major version upgrade, run the following from command line in the ignition folder:

    Code Block
    lib\runtime\jre-win\bin\java.exe -classpath "lib/core/common/common.jar" com.inductiveautomation.ignition.common.upgrader.Upgrader . data logs file=ignition.conf


  8. Start Ignition. Run start-ignition.bat

At this point, the Gateway will start, completing the upgrade. 


Linux (Including ARM)

Note_friendly

64-bit zip installers are available for ARM machines.


For a new installation from a ZIP file, do the following:

  1. Unzip the contents of the ZIP file. Wherever this file in unzipped is where Ignition will be installed, so be sure to unzip this file in a suitable location. Below, you can see the contents of the zip file in /user/local/bin/ignition which is the default Linux installation directory for Ignition.



  2. Open up a terminal command, navigate to the directory where you unzipped the installer and make the ignition-gateway file and all .sh files executable. You can run the following commands: 

    Code Block
    chmod +x ignition-gateway
    chmod +x *.sh


  3. Execute  ignition.sh

    Code Block
    ./ignition.sh start

That's it. You can navigate to the Gateway's Webpage ( http://localhost:8088 ) to start the commissioning process. If any errors occurred during startup, they'll be recorded in logs/wrapper.log file. 

You can also add the unzipped folder to your system PATH by adding the folder path to a file such as .profile or .bashrc. This allows you to start programs like the Gateway Command-line Utility - gwcmd from the command line without specifying a complete path to the unzipped folder.

Upgrading

and

an Existing Linux Installation

If you are upgrading from a preexisting installation, follow these steps:

  1. Take a Gateway backup from the running system and store it in a safe location. 
  2. Stop your Ignition service. Open a terminal window and navigate to your Ignition installation directory (/user/local/bin/ignition is the default install directory location and it is also the location we use in the installation steps above) and run the command below: 

    Code Block
    ./ignition.sh stop



  3. Delete both the "lib" and "webserver/webapps" folders. 
  4. Unzip the contents of the new zip installer into the current directory and allow files to be overwritten 
  5. Set the executable permission on all .sh files in the unzipped folder by running this command: 

    Code Block
    chmod +x *.sh


  6. Unzip the new runtime: 

    Code Block
    tar -C lib/runtime -xf lib/runtime/jre-nix.tar.gz


  7. If this is a major version upgrade (8.0 to 8.1) then the data/ignition.conf file may have changed. If this is a minor version upgrade (8.0.1 to 8.0.2) then skip to step 8.
    To upgrade the ignition.conf file for a major version upgrade, run the following from command line in the ignition folder, run the following: 

    Code Block
    lib/runtime/jre-nix/bin/java -classpath "lib/core/common/common.jar" com.inductiveautomation.ignition.common.upgrader.Upgrader . data logs file=ignition.conf


  8. Start Ignition. Run: 

    Code Block
    ./ignition.sh start



Mac

For a new installation from a ZIP file, do the following:

  1. Open up Terminal.app and change directories to the same directory the ZIP install is located. If you downloaded to your desktop then it would be:

    Code Block
    cd ~/Desktop


  2. Become root:

    Code Block
    sudo su


  3. Unzip Ignition (Replace X.X.X with the actual build number). This unzips the contents of Ignition-osx-X.X.X.zip in /usr/local/ignition which is the default MAC OS installation directory for Ignition.

    Code Block
    unzip -d /usr/local/ignition Ignition-osx-X.X.X.zip


  4. Change directory to the directory where you unzipped the contents of the zip installer or /usr/local/ignition in this example. 

    Code Block
    cd /usr/local/ignition


  5. Make the make the following files executable:

    Code Block
    chmod +x *.sh
    chmod +x ignition-gateway


  6. Create a symlink in /usr/local/bin

    Code Block
    cd /usr/local/bin
    
    ln -s /usr/local/ignition/ignition.sh ignition


  7. You can now start Ignition from Terminal.app using the starting and stopping commands listed above. Start Ignition with:

    Code Block
    ignition start

    That's it. You can navigate to the Gateway's web interface ( http://localhost:8088 ) to start the commissioning process. If any errors occurred during startup, they'll be recorded in logs/wrapper.log file. 

    You can also add the unzipped folder to your system PATH by adding the folder path to a file such as .profile or .bashrc. This allows you to start programs like the Gateway Command-line Utility - gwcmd from the command line without specifying a complete path to the unzipped folder.

Upgrading an Existing MacOS Installation

If you are upgrading from a preexisting installation, follow these steps:

  1. Take a Gateway backup from the running system and store in a safe location.
  2. Stop Ignition. Run:

    Code Block
    ignition stop



  3. Delete both the lib and webserver/webapps folders.

  4. Unzip the new ZIP into the old Ignition directory, allowing files to be overwritten.
  5. Set the executable permission on all .sh files and the ignition-gateway file: 

    Code Block
    chmod +x *.sh
    chmod +x ignition-gateway


  6. Unzip the new runtime:

    Code Block
    tar -C lib/runtime -xf lib/runtime/jre-mac.tar.gz


  7. If this is a major version upgrade (8.0 to 8.1) then the data/ignition.conf file may have changed. If this is a minor version upgrade (8.0.1 to 8.0.2) then skip to step 8.
    To upgrade the ignition.conf file for a major version upgrade, run the following from command line in the ignition folder, run the following:

    Code Block
    lib/runtime/jre-mac/bin/java -classpath "lib/core/common/common.jar" com.inductiveautomation.ignition.common.upgrader.Upgrader . data logs file=ignition.conf


  8. Start Ignition. Run:

    Code Block
    ignition start




New_in
Version8.1.2




Note_friendly

Updated the user manual to include preconfiguring a Gateway in the following section, Deploying Ignition to Another System. The instructions apply to Ignition version 8.1.2 and future versions of Ignition.  It does not apply to prior Ignition versions preceding 8.1.2. 


Deploying Ignition to Another System

Some users are interested in "preconfiguring" an Ignition Gateway. That is, configuring an instance of an installation, and then moving the installation files to a new server. This can be useful in cases where you're attempting to push out new Ignition installations via command-line interface to multiple separate systems.

Normally, you need to install Ignition manually on each of these systems and walkthrough the commissioning process to create an initial user and select an Ignition edition, which defeats the purpose of this whole deployment strategy. Thus, the following example will demonstrate how to deploy a preconfigured Ignition Gateway that has already been commissioned and is ready to start up. 

Requirements

You'll need the following:

  • A ZIP installer for the OS and Ignition Version you're planning to deploy on. ZIP installers can be found on our Downloads page. 
  • An existing Ignition Gateway where you already accepted the End User License Agreement (EULA). This existing Gateway must match the Ignition version of the system you're going to deploy to. If you don't have an install available, simply run through the installation process once, agree to the terms in the EULA, and finish the rest of the commissioning process. Accepting the EULA is important because you'll need to manually do this once. 
  • An Ignition Gateway backup from an existing system. We'll use this to define the initial user, and carry over any other resources we want on the new system. This can be a backup from the Gateway you used in the previous requirement. We'll use this backup to inject a user account that only you have credentials for. 

Example

  1. Locate the EULA hash from your existing Ignition Gateway. You will find the hash in the commissioning.json file in Gateway's installation directory: %installDirectory%/data/commissioning.json.  

    Note_friendly

    You'll only find this file on systems that have completed the commissioning process. 

    Part of the commissioning process involves accepting the EULA. The steps in this guide involve skipping the commissioning process, including the EULA. Thus, to be able to follow along with this guide you'll need to review the terms in the EULA and manually accept them on a separate system. 



  2. Open the file in a text editor, and copy the value for the eulaSetup.eula key, including the quotation marks. For example, assuming a file looked like the entry below, you would copy "XXXXX" (the actual hash will be much longer). Save this value for later, as we'll need to reference it in a future step.

    Code Block
    {
      "isCommissioned": "COMMISSIONED",
      "connections.useSsl": "false",
      "eulaSetup.eula": "XXXXX"
    }


  3. Next, take the Ignition installer and unzip it into a directory that's easily accessible. This directory will be the base directory that we'll ultimately end up deploying to on one or more different servers. 

  4. In the base directory, edit the Gateway's configuration file (ignition.conf) using the text editor of your choice. The file is located at %baseDirectory%/data/ignition.conf  

  5. Part of the installation process normally includes an edition selection, but we can bypass that by modifying the configuration file to explicitly state which edition the Gateway should be set to. Located the "Java Additional Parameters" line in the configuration file. The should have some entries like the following: 

    Code Block
    # Java Additional Parameters
    wrapper.java.additional.1=-Ddata.dir=data
    #wrapper.java.additional.2=-Xdebug
    #wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000

    at the end of that section, add the following:

    Code Block
    wrapper.java.additional.2=-Dedition=%value%


    Where %value% is the edition, you want the deployed system to use: "edge" for Ignition Edge, and "maker" for Ignition Maker. For "standard" edition, simply omit the "=%value%" portion. For example, the file should look something like the following when configuring for Standard edition:

    Code Block
    # Java Additional Parameters
    wrapper.java.additional.1=-Ddata.dir=data
    #wrapper.java.additional.2=-Xdebug
    #wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000
    wrapper.java.additional.2=-Dedition


    And the file would look like the following if deploying Edge edition:

    Code Block
    # Java Additional Parameters
    wrapper.java.additional.1=-Ddata.dir=data
    #wrapper.java.additional.2=-Xdebug
    #wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000
    wrapper.java.additional.2=-Dedition=edge


  6. Save the changes you made to the configuration file. 
  7. Also in %baseDirectory%/data/, create a text file and call it commissioning.json.

  8. Edit the newly created commissioning file, and set contents to the following:

    Code Block
    {
      "isCommissioned": "COMMISSIONING",
      "connections.useSsl": "false",
      "eulaSetup.accepted": "true",
      "eulaSetup.eula": "xxxxxxxxxxxxxxxxxxxxx",
      "authSetup.username": "admin",
      "authSetup.password": "[e811cfc7]fc3b28ad5f73331c94790129f0931437ac31d59376b0e4b15df580a8841ba165"
    }


    The JSON above does a couple of things, but notably defines an initial user on the new system. The user is "admin", with a user of "password". Later, we'll restore from our Gateway backup which will replace this initial user, but for now, we simply need to have a user to bypass commissioning. 

  9. In the same commissioning file, replace the value of the eulaSetup.eula  key with the value you took from step 2.

  10. Save the commissioning file. 

  11. At this point, you're ready to deploy. Take the contents of your base directory, move them to a new server, and perform a normal ZIP installation. When the Gateway starts, it will bypass the commissioning process and the Gateway will immediately startup. 

  12. Once the Gateway is running, you can use the admin user we configured earlier to access the newly deployed instance of Ignition. From here, you can restore from the Gateway Backup file mentioned in the requirements section of this guide. You can do this from command-line which would look something like the following:

    Code Block
    gwcmd --restore /path/to/your/GWBK