Installing or Upgrading a Module


Learn how to install, upgrade, or uninstall a module after Ignition is installed.

Video recorded using: Ignition 8.0


(open in window)

[00:07] There may come a time when you want to add a new module to your Ignition Gateway to get some new feature that you didn't have before or even update a module that you already have within your Gateway to get the latest fix from a newer module. Both of these things are really easy to do within the Ignition Gateway Webpage. First, we need to open up a web browser and come to our Gateway Webpage at localhost:8088. We then need to go to the configure section and log in with your user name and password. Once here in the Configure section, we're then going to go to the Modules page on the left hand side underneath the Systems section.

[00:52] Here, we get a list of all of the modules that we have currently installed within our Gateway. Currently, there is a module that I don't have that I would like to add and that's the Alarm Notification module. To add a new module, I simply need to scroll down to the bottom of this page and click on the Install or Upgrade a Module... link at the bottom left. On this next page, we need to click on the choose file button in the upper left hand corner and choose the file for the module that we want to install. I've already downloaded a couple of module files from our website for us to experiment with. You'll notice that these module files have a special extension, .modl which stands for module.

[01:39] I'm going to select this module and then click on the open button in the lower right hand corner and then the install button. You may be taken to a page like this where you need to accept a new software Module License Agreement if there's a new version of it in this module. We simply need to click on the check box, I accept the terms in the license agreement in the lower left hand corner and then click on the accept license button just below that. The module might also have a new certificate. If it does, you'll be taken to a page that looks like this where you need to add the module certificate to your list of trusted certificates. To do so, simply click on the checkbox next to, I want to add this certificate to my trusted certificates and then click on the add certificate and install module button. As you can see, I now have a new module in my new module list, the Alarm Notification module. Now the version of the module that we just installed is version 5.0.0-beta0.

[02:47] I just so happen to have a newer version of the module so let's take a look at what the upgrade process is for individual modules as well. It actually works in much the same way that we installed the original module. I simply scroll down to the bottom of the page and click on the install or upgrading module link. Again, I need to click on the choose file button and select the module file that I want to install. In this case, I'm going to select my newer Alarm Notification module and then click on the install button. You'll notice this time I didn't have to accept a license agreement or add a certificate to my list of trusted certificates. This is because the new module used the same license agreement and certificate as the older version of the module so I didn't need to go through that process again. However, because it is a newer version of the module, the version number for this module now reads 5.0.0-rc0 so I've now updated my module to the latest version.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.