Versions Compared

Old Version 47

changes.mady.by.user Nichole Boehnke

Saved on

compared with

New Version 48

changes.mady.by.user Susan Hartzman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The installation process for Ignition is designed to be as simple as possible. You can find installers on our Downloads page: https://inductiveautomation.com/downloads/ignition/.

You'll find the dedicated Installers (just called "installer" for all major operating system. You'll also find ZIP files.  Both options install Ignition, but the installers are generally easier to use. Download an installer, and head to the appropriate section below. For information on ZIP file installation instead, go here.  

Make sure your system meets our minimum system requirements (also found on our downloads page). 

New_in
Version8.1.17


The installer now provides timestamped logs for installs and upgrades in the logs directory. Timestamped uninstall logs are stored in the root install directory.

Install Ignition

  1. Download an installer from our downloads page: https://inductiveautomation.com/downloads/ignition/.

    Note_friendly
    TitleInstalling on a Headless Server?

    The steps below detail installing Ignition in a graphical environment. If you're attempting to install Ignition on a headless server, you can use the same installer, but you'll likely want to refer to the Command Line Installations page for details on command line arguments, which allow you to do things like run the installer in unattended mode. 

    Installing on Headless Linux Distros

    When installing Ignition on a headless Linux distro, you'll want to install the fontconfig package, as some Ignition features use the package. 

    Code Block
    sudo apt-get install fontconfig

  2. Run the installer and follow the steps in the installation wizard. 


    Note_friendly

    When selecting an installation type, the Typical options includes a selection of many popular modules. Additional modules can be added after the installation. Just use the Typical option for now. 

    Expand
    titleClick here if you're installing on Linux...
    Info
    titleLinux Installations

    Make the Installer Executable

    Before you can run the installer on Linux, you must first make the installer executable. From terminal:

    Code Block
    chmod +x ignition-x.x.x-linux-xxxinstaller.run


    Alternatively, your desktop environment may have some graphical interface to make the installer executable. Check your desktop's documentation for more details.

    Expand
    titleClick here if you're installing on macOS...
    Info
    titlemacOS Installations

    There is a known issue with running the installer on macOS. If you're receiving warnings about being unable to open the installer, see our Knowledge Base Article. 

    Expand
    titleClick here for a breakdown of the Installer Settings...

    In most cases you can use the default settings in the installer. This section describes what each setting does. 

    Default Installation Directories

    This determines the installation directory. You're free to pick the directory you wish. See the Ignition Default Installation Directories section below for the default paths.

    Gateway Service Name (Windows Only)

    This field allows you to choose the service name of Ignition, as it appears in the operating system's service listing. 

    Installation Options

    Allows which modules are included in your base installation. Your choices are Typical and Custom. The Typical option will use a select list of commonly used modules. The Custom option allows you to install specific modules. In most installations the Standard option will suffice, but do note you can always add modules and remove modules after the installation process. 

    Start Ignition Now

    Once the installer finishes, you'll be provided with an option to start the Gateway immediately. In most cases this is the desired option. You would only opt out of this choice if you didn't want the Gateway to start once the installer finishes. 

    Once finished, a web browser will open, and start off the System Commissioning process. 

    Install As a Service (Linux and MacOS only)

    Allows you to install Ignition as a service, allowing you to manage certain actions via command line. It is recommended to opt into this setting. For Windows systems Ignition is installed as a service by default as it is a requirement for Ignition to run. 

  3. After the installation wizard finishes, a web browser will open and start the commissioning process. At this point you'll need to select your edition. 

    Image Removed

    Editor_notes


    On 8.1.21 release, replace this screenshot

    Image Modified



    Standard IgnitionEdition - Unlimited edition of our flagship platform. Designed for commercial use.

    Editor_notes

    On 8.1.21 Replace Standard 'Ignition' with Standard 'Edition'


    Ignition EdgeEdge Edition     -  A lightweight version edition of Ignition suited for edge-of-network installations.

    Editor_notesOn 8.1

    .

    21
    Replace 'Ignition Edge' with 'Edge Edition'
    Replace 'version' with 'edition'



    Ignition Maker Edition - A free, limited version edition of Ignition for personal, non-commercial projects.

    Editor_notesOn 8.1.21
    Delete 'Ignition' from 'Ignition Maker Edition'
    Replace 'version' with 'edition'



  4. Follow the steps in the commissioning process to complete installation.

    Expand
    titleClick here for more information about commissioning

    The System Commissioning process is a series of steps that further configure your Gateway. This process begins after installation or upgrading. In addition, it can be re-triggered via a password reset with the Gateway Command-Line Utility. 

    New_in
    Version8.1.1


    As of 8.1.1, commissioning can now set the Gateway Network port in addition to the HTTP and HTTPS port. 

    Clean installs of Ignition will check the default ports for their availability. If no ports are available, the Gateway will iterate that port number until one is found that is available. These ports can be modified during the commissioning process. 

    Existing or upgraded Gateways will not search for available ports, and will result in a faulted Gateway.


    Activate License (Maker Edition Only)

    When installing Maker Edition, you'll be asked to provide a License Key (an 8 digit string) and an Activation Token (a considerably longer string). Both of these can be acquired for free from your Inductive Automation account: https://account.inductiveautomation.com/.

    Create a User

    This step asks you to create an initial user. This user will have full access to Ignition, although you're free to modify this user later. You'll need this user account to make changes to Ignition at all, so make sure you remember these credentials. Otherwise you'll need to perform a password reset: see the Gateway Command-Line Utility page. 

    HTTP Configuration

    Allows you to specify the ports Ignition uses. By default, HTTP is 8088, and HTTPS is 8043. 

Once you finish the commissioning process, your service will start. 

On_this_page


Scroll html ignore
Iulink
URLhttps://www.inductiveuniversity.com/videos/installing-ignition-on-windows
NameInstalling Ignition on Windows


Scroll html ignore
Iulink
URLhttps://www.inductiveuniversity.com/videos/installing-ignition-on-linux
NameInstalling Ignition on Linux


Scroll html ignore
Iulink
URLhttps://www.inductiveuniversity.com/videos/installing-ignition-on-mac
NameInstalling Ignition on Mac


Ignition Default Installation Directories

The default directories for each operating system are listed below. 

Windows

Code Block
C:\Program Files\Inductive Automation\Ignition

MacOS

Code Block
/usr/local/ignition

Linux

Code Block
languagebash
/usr/local/bin/ignition

MacOS and Linux Installation Directory

New_in
Version8.1.10


Mac and Linux installations contain a ignition.sh file and ignition-util.sh file, which both contain some configuration parameters for the installation. Modifying these files is not advised, unless directed to by a member of our support team. Instead, an ignition.shconf file, which is also located in the installation directory, should be used instead. 

Additionally, during installation on Mac and Linux, the installer will create a sudoer file at installationDirectory/etc/ that insures the gateway can be restarted without an interactive login. In most cases, the sudoer file does not need to be modified or maintained. However more information can be found in the ignition-util.sh file in the installation directory. 


Quick Start Configuration

New_in
Version8.1.0


Once the installation process has finished, you'll be redirected to the Gateway Webpage. From there you'll be asked to opt into the Quick Start configuration, which makes several configuration changes to the system. Quick Start can only be enabled upon a new installation.

The following changes are made once Quick Start is enabled:

  • Creates an internal SQLite database connection.
  • Configures a device connection to a Programmable Device Simulator instance, and adds Tags from the simulator into a Tag provider. 
  • Configures an internal alarm journal.
  • Creates a sample project. 


Start or Stop Ignition

After installing with the Installer, Ignition will have a service representing it on the operating system. By default Ignition will start when the system starts, but you can manually start and stop the system with the following terminal commands:

Windows

The examples below assume "Ignition" is the service named used during installation (which also happens to be the default service name). You may need to modify the examples below using your system's service name. 

Code Block
net start Ignition
net stop Ignition

Mac

Code Block
/usr/local/ignition/ignition.sh start
/usr/local/ignition/ignition.sh stop
/usr/local/ignition/ignition.sh restart

Linux

The examples below use the default installation directory

Code Block
/usr/local/bin/ignition/ignition.sh start
/usr/local/bin/ignition/ignition.sh stop
/usr/local/bin/ignition/ignition.sh restart


Upgrade Ignition

Upgrading Ignition is as easy as running the installer. When you run the installer from the same directory as a previous install, our installers are able to detect that Ignition is already installed. If Ignition is already installed, the installer will ask if you would like to proceed with the upgrade. A wizard takes you through the upgrade in a similar workflow as installation workflow. 

Ignition installers can be used to upgrade any edition of Ignition (i.e., Edge, Maker, or Standard) with the exception of ARM as that will require a zip installer for upgrading. 


Note_friendly
TitleLinux Installer

Older versions of the Linux installer would place files across multiple different directories. Running an 8.0.14+ installer will move all those files to the specified installation directory. 

Note_friendly
TitleJDBC Drivers and Upgrading

Sometimes new versions of Ignition will incorporate new JDBC drivers, which are used to connect to SQL databases. When upgrading Ignition, the JDBC drivers will not be upgraded. The reason being, is that you should only need to change the JDBC driver if you upgrade your database. See the JDBC Drivers and Translators page for more details. 



During the upgrade process, the Gateway will have to restart, so make sure to account for downtime when upgrading. 

When you upgrade Ignition, you'll also be given the option to update any additional modules you currently have installed, including Third-Party modules.  On the Select Modules screen, there is a tab for the modules included in your version of Ignition, and a tab for Additional Modules you may be using.  Under the Action column, you can choose to upgrade or remove the module or leave it unchanged.

Updating License for an Upgrade

If you are updating from one major version to the next (i.e, upgrading from version 8.0.# to version 8.1.#) , you will need an updated license. You can do this before upgrading so there is no unlicensed time after the upgrade.

  1. Let us know.
    You can reach Inductive Automation by phone at (800) 266-7798.
    Some Major upgrades include new modules or have modified the functionality of pre-existing modules. If your license needs to be updated, call us and we can guide you through it. If you are updating from one version to the next, or from 7.0.0 all the way to the latest version, we can talk you though what is different and what new functionality is available. See the New in this Version page for more specifics about what was updated in the various versions.

  2. Reload your license. 
    Once your license is updated in our system, go to your Config section of the Gateway webpage, and click System > Licensing. Click on the Update License icon .
    For for a detailed guide on reloading a license, see updating a License on this page. If you are coming from an older version, the Gateway may look different. Don't worry, all this functionality is still there, but you may have to un-activate then re-activate instead if the Update License button is missing.

Upgrading a Redundant Pair

There are a few extra things to consider when upgrading a redundant pair of Gateways. When performing the upgrade locally, we recommend upgrading the Master first. This allows the Backup to take over when the Master is down for an upgrade, and the Master can resume operations when it comes back online. At this point the Backup can be upgraded without interruption. The same considerations mentioned above should also be applied to the redundant pair, but you only need a Gateway Backup file from the Master Ignition Gateway.

If the upgrade will be performed remotely using the Enterprise Administration Module, then the Backup Gateway should be upgraded first. This allows the EAM controller to manually tell clients/sessions to communicate with the newly upgraded Backup Gateway, even though the Master will be a different version, allowing time to upgrade the Master.


Reset the Password

To reset the main password for the user with full privileges, use the Gateway Command-line Utility (gwcmd) utility.  The 'gwcmd' utility triggers system commissioning, and prompts the user to reset the username and password for the main user (with full privileges) after the Gateway restarts.  Linux and Mac OS platforms also use the 'gwcmd' utility for password reset. For more information, see the Gateway Command-line Utility - gwcmd page.



Uninstall Ignition

Note_friendly

Uninstalling Ignition will remove any projects or Gateway level configurations you made. If you wish to preserve anything, make sure to take a Gateway backup first.


To uninstall Ignition, run the uninstaller file. This file can be found in the main Ignition installation directory, for example:

Code Block
titleWindows
C:\Program Files\Inductive Automation\Ignition\Uninstall.exe
Code Block
titleMac
/usr/local/ignition/Uninstall.app
Code Block
titleLinux
/usr/local/bin/ignition/Uninstall.run