Upgrading Ignition
Upgrading from 7.6 or earlier?
Please read the v7.7 Upgrade Guide below before you begin.
Choose your operating system for detailed instructions on upgrading Ignition.
- Windows
- Mac OS X
- Linux
You should backup your Gateway, see Gateway Backups.
The Ignition installer also doubles as an upgrader, thus upgrading Ignition is very similar to downloading a new version and installing from scratch. You can see your current Ignition version by looking in the Status page of the Gateway.
To Upgrade Ignition on Windows
-
Simply download the Windows executable installer from our website, and double-click on the executable installer.
A window is displayed asking you Continue with upgrade?
noteMake sure you download the 32-bit installer for a 32-bit Windows installation, and the 64-bit installer for a 64-bit Windows installation. If you attempt to upgrade a 32-bit installation with a 64-bit installer, or vice versa, you will get an error message.
-
Click Yes to start the upgrade process.
-
Accept the license agreement. The Upgrade Mode window is displayed.
-
You choose either:
No, just upgrade currently installed modules
The Ignition base installation and the existing modules are upgraded.
Or you can choose:
Yes, let me choose which modules to add or remove
The Select Components window is displayed and you can then add a module that was not part of the original installation or uninstall/remove a currently installed module. You can view a brief description of each module by clicking on the module name. Selecting the check box next to a module installs the module as part of the upgrade.Clearing the check box next to a module uninstalls the module during the upgrade. -
Click Next. The Ready to Install window is displayed.
Ignition is ready to be upgraded. At this point, you may click Back to change your selections. -
Click Next to finish the upgrade. Once the upgrade process starts, it may take a few minutes to finish. At the end of the upgrade process, the Setup window is displayed letting you know that Setup has finished installing Ignition on your computer.
-
Select the check box for Start Ignition now and click Finish.
A splash screen displays informing you that the Ignition service is starting. Once the Ignition Gateway starts up, your web browser opens and brings you to the Gateway Homepage.
You can go back and check the Status page of the Gateway to see that a new version of Ignition is now installed.
Automated Upgrading
You can silently upgrade Ignition from a command shell without showing any user prompts. Remember to make a Gateway backup before performing any type of upgrade. Also, the installer cannot automatically start the Gateway after a silent upgrade.
Use the net start ignition command as shown below.
gwcmd -b C:\backups\mybackup.gwbk
Ignition-7.x.x-windows-x64-installer.exe --mode unattended --unattendedmodeui none --autoupgrade true
net start ignition
Flags
-- mode unattended(ensures that no prompts appear during installation)-- unattendedmodeui none | minimal(the none flag does not display any sort of graphic during installation; the minimal flag displays a small progress bar and nothing else)-- autoupgrade true(disables any Are you sure? prompts when running the upgrader so that a user can run an automated upgrade without any user interaction)
You should backup your Gateway, see Gateway Backups.
-
From Gateway, go to Configure > Backup / Restore.
-
Click on Download Backup to back up the entire project from the existing installation. The
.gwbkbackup file is created in the Downloads folder. -
Shut down Ignition by typing the following from the command-line:
/usr/local/bin/ignition stop -
Move the existing installation folder somewhere else.
-
Unzip the new installation and place it in the location of the old installation.
-
Start the new installation.
/usr/local/bin/ignition start -
Go to Configure > Backup / Restore and click Restore to perform the restoration.
You should backup your Gateway, see Gateway Backups.
Also, you need to be able to run as ROOT (prefix everything with sudo, run sudo su, or login as root user) to perform the upgrade.
Unlike some Linux operations, the Ignition Linux upgrade process is designed to be as simple as possible. Note that while Ignition is currently optimized for Ubuntu Linux, the upgrade process will work for any Linux distribution.
The Ignition installer also doubles as an upgrader, thus upgrading Ignition is very similar to downloading a new version and installing from scratch. You can see your current Ignition version by looking in the Status page of the Gateway.
To Upgrade Ignition on Linux
-
Simply download the Linux executable installer from our website, and double-click on the executable installer.
noteMake sure you download the 32-bit installer for a 32-bit Linux installation, and the 64-bit installer for a 64-bit Linux installation. A 32-bit installer does not launch in a 64-bit system and vice versa.
-
After downloading the installer, open a command shell and navigate to the installer executable.
-
Run
chmod 744 * -
Then run
./ignition_X.X.X-installer.run- If you are running the installer in a shell in a graphical environment, the graphical installer opens automatically.
- If you are running the installer in a headless Linux installation, or through a SSH shell, the text installer opens automatically.
- If you want to run the text installer in a graphical environment, add
--modetext to the end of the above command.
The installer starts running.
-
Agree to the licensing terms and click Forward. The Installation Directory window is displayed.
-
Click Forward to accept the default installation directory.
Linux does not have the concept of a central registry like Windows systems do. Therefore, you must provide the location of the existing Ignition installation. By default, this value is/usr/local/bin/ignition, unless you have installed Ignition in another location. -
In the Question window, click Yes to continue. This Question window is displayed when the upgrader was able to locate Ignition in the specified folder. After you click Yes, the Upgrade Mode window is displayed.
-
You choose either:
No, just upgrade currently installed modules
The Ignition base installation and the existing modules are upgraded. This is the choice for most scenarios.Or you can choose:
Yes, let me choose which modules to add or remove
The Select Components window is displayed and you can then add a module that was not part of the original installation or uninstall/remove a currently installed module.In graphical mode, you can view a brief description of each module by clicking on the module name. Selecting the check box next to a module installs the module as part of the upgrade. Clearing the check box next to a module uninstalls the module during the upgrade.
In text mode, a list of all the modules is displayed, one at a time. Type y to install or upgrade the module, and type n to uninstall the module.
-
Ignition is ready to be upgraded. At this point, you can click Back (graphical mode) to change your selections, or you can only abort the upgrade at this point (text mode) by typing n.
-
To finish the upgrade, click Next (graphical mode) or type y (text mode).
-
When the upgrade is complete, click Finish (graphical mode) or type y to start Ignition or n to exit (text mode).
If the box for Start Ignition now was selected, Ignition starts as a background process.
-
Use a web browser and go to http://localhost:8088 to confirm that your Gateway is running. For instructions on how to stop or start Ignition, see Installing Ignition.
Automated Upgrading
You can silently upgrade Ignition from a command shell without showing any user prompts. Remember to make a Gateway backup before performing any type of upgrade. Also, the installer cannot automatically start the Gateway after a silent upgrade.
Use the /etc/init.d/ignition start command as shown below.
gwcmd -b /var/backups/mybackup.gwbk
sudo ./ignition-7.x.x-linux-x64-installer.run --mode unattended --unattendedmodeui none --autoupgrade true
/etc/init.d/ignition start
Flags
-- mode unattended(ensures that no prompts appear during installation)-- unattendedmodeui none | minimal(the none flag does not display any sort of graphic during installation; the minimal flag displays a small progress bar and nothing else, but only if you are working in a graphical system)-- autoupgrade true(runs the installer in upgrade mode)
v7.7 Upgrade Guide (Upgrading from 7.6 or Earlier)
The following applies specifically when upgrading a legacy system from Ignition 7.6 or earlier to 7.7. It was originally published as a standalone tip sheet and is preserved here for reference.
Thinking of upgrading your existing Ignition system to version 7.7? Can't wait to get your hands on all those new features? Great! But first, read this short upgrade guide to be prepared.
1. Make a Backup First
Before any major upgrade, it is important to make a backup of your existing system, and write down what version you were using. That way, if you encounter any unexpected turbulence, you can revert back quickly.
2. Report Issues
If you find anything out of place, let us know! Visit the Ignition 7.7 forum to report any anomalies you find.
3. Call Your Sales Rep
Ignition 7.7 is a major upgrade to the Ignition platform and all of its modules. When you upgrade, all of your modules will revert back to trial mode until you update your license.
- If you have Ignition Total Care Upgrade Protection, you don't need to pay anything additional to upgrade your license key, but you will need to update the license that is installed on your server(s). If you have internet access on your Gateway, this is as easy as clicking the Update License link on the license page of the Gateway's configuration web interface. If you don't have internet access, you'll need to do an offline activation.
- If you don't have Total Care Upgrade Protection, you'll need to contact your sales rep and arrange to purchase the upgrade.
4. Upgrade Java
Ignition 7.7 requires Java SE 8 for the Gateway. Clients and Designers still support Java 6, 7, and 8.
5. Custom Tomcat Settings
If you added items like MIME types to the tomcat/conf/web.xml folder by hand, you'll need to apply those changes to webserver/webdefault.xml after upgrading.
6. Scripting Changes
Ignition 7.7 has a number of new scripting features. If you're a heavy script user, you should be aware of what these changes mean.
- Going forward,
app.*is being replaced byproject.*. However, if you upgrade an existing installation withapp.*scripts, they will remain indefinitely. Whether you move them over to theproject.*space is up to you. - New scripting locations use new scoping rules. Ignition's scripting semantics have changed somewhat for new scripts. We now correctly use Python's module scoping rules. This has two major effects:
-
Variables are now directly accessible from within functions. For example:
Old Scopingx = 5
def myFunction(x = x):
print xNew Scopingx = 5
def myFunction():
print x -
The
globalkeyword now works differently. Instead of making the variable truly "global", it declares it global within the scope of the current module. See the Python Programming FAQ for more details. In order to make new scripts compatible with older scripts that used global variables, there is a new function,system.util.getGlobals(), which provides access to the old global space.
-
