--- title: "Installing or Upgrading a Module" --- # Installing or Upgrading a Module > >

## Module Configuration All module configuration is done from Gateway Webpage in the **Config** > **Modules** section. From here you can add, remove, and restart modules. Modules integrate their settings into the Gateway configuration tree, and therefore do not offer settings in this section. ![](install-upgrade-mod-imgs/2019-03-18_11-11-08.png) ## Downloading a Module Ignition comes with some default modules when installing the software. There may be a few modules you require that are not included when performing the initial installation, however. To find the module(s) you require, follow the instructions below. 1. Go to the [downloads page](https://inductiveautomation.com/downloads/) on the Inductive Automation website. ![](install-upgrade-mod-imgs/image2022-7-5_12-32-50.png) 2. Click on "Other Versions", located under the Ignition tablet and mobile device graphic. By default, this will take you to different installers and modules for the **latest** version of Ignition. ![](install-upgrade-mod-imgs/image2022-7-5_12-38-20.png) 3. Select which version of Ignition you are currently running. 4. Scroll down the page until you see which module you are looking for. Once you click on the target module, it will start downloading the .modl file. ## Install or Update a Module :::note Installing a module will require connected Vision Clients and Designers to restart. Perspective Sessions will not require a restart. Production systems using either Clients or Designers should wait for downtime before installing a module. ::: 1. On the Gateway Webpage, select **Config** > **Modules** to open the **Module Configuration** page. 2. Scroll to the bottom on the list, find the blue arrow, and click the **Install or Upgrade a Module** link. ![](install-upgrade-mod-imgs/2019-03-18_11-27-04.png) 3. Click **Choose File**, select a .modl file that you have previously downloaded. :::info Don't have an Ignition module already downloaded? Go to the Inductive Automation [downloads page](https://inductiveautomation.com/downloads/). Search for the module you want and save it to your Downloads folder on your computer. **Third Party Modules** All third party Ignition modules require the Ignition platform to be installed. To install third party modules: * Install Ignition: See [Installing and Upgrading Ignition](installing-and-upgrading.md). * Once Ignition is installed, download the module and install it in the Ignition Gateway. ![](install-upgrade-mod-imgs/sepasoft-modules.png) Go back to the **Install or Upgrade Module** screen and browse your Downloads folder for your module, select it, and click **Open**. Ignition will copy the path to the module to the Browse field and all that's left for you to do is click **Install**. ::: 4. Click **Install**. When the page reloads you can now see the module you installed in the list of modules. ### Manual Module Installation Alternatively, you can add module files directly to your Gateway File System by following the steps below: 1. Navigate to the `%IgnitionInstallationDirectory%/user-lib/modules` folder. 2. Add your .modl file to your modules folder. 3. Restart your Gateway service. Your new module will now be ready to use. ## Uninstall a Module :::note Uninstalling a module will require connected Vision Clients and Designers to restart. Perspective Sessions will not require a restart. Production systems using either Clients or Designers should wait for downtime before uninstalling a module. ::: 1. On the Gateway Webpage, select **Config** > **Modules** to open the **Module Configuration** page. 2. Scroll to the module you want to uninstall. 3. Select **Uninstall** on the right of module name. A confirmation message appears. ![](install-upgrade-mod-imgs/2019-03-18_11-32-09.png) 4. Click **Confirm**. The module is no longer installed and is removed form the list. ## Restart a Module Because of the isolated nature of modules, the other modules are not affected by the restart (unless they depend on that particular module). 1. On the Gateway Webpage, select **Config** > **Modules** to open the **Module Configuration** page. 2. Scroll to the the module you want to restart. 3. To the right of module name, click the **restart** button. ![](install-upgrade-mod-imgs/2019-08-15_15-19-47.png) 4. Click **Confirm** at the confirmation message. ![](install-upgrade-mod-imgs/2019-08-15_15-21-09.png) Ignition will give you a confirmation message when the module has restarted. ![](install-upgrade-mod-imgs/2019-08-15_15-22-26.png) ## Module Status The installed module list on the **Module Configuration** page also provides some basic information about the **State** of the module. The **Version**, **License**, and **State** columns are all displayed in the list. Module licensing is performed centrally in **System** > **Licensing**, so the values here are only for information purposes. ![](install-upgrade-mod-imgs/2019-08-15_15-24-05.png) ### Module Shows as Faulted After Installation In some cases, a module may appear to install successfully, but its functionality does not become available. A common cause of this behavior is a version mismatch between the installed module and the Ignition platform. For a module to load correctly, the middle digit of the module version must match the middle digit of the Ignition platform version. If a version mismatch is detected, the module will display a State of **Faulted: Exception while starting up module** on the Module Configuration page. ![](install-upgrade-mod-imgs/module-version-incorrect.png) To verify compatibility, navigate to **Status** > **Overview** and note the Ignition version currently running on your Gateway. ![](install-upgrade-mod-imgs/ignition-version.png) Because the WebDev module shown above has 3 as the middle digit and the Gateway has 1, there is a version mismatch and the module will remain in a faulted state. To resolve this, download the correct version of the module from the Inductive Automation [Downloads](https://inductiveautomation.com/downloads/ignition) page. Use the Ignition Version dropdown or Version Archive tab to select the Ignition version that matches your Gateway. From the list of available modules, locate the compatible version and download it. ![](install-upgrade-mod-imgs/matching-versions.png) After installing the compatible version, the module will show a State of **Running**, and will become available for use. ![](install-upgrade-mod-imgs/module-version-running.png) ## Verify Trusted Modules Verify the authenticity of Ignition modules on the **Config** > **System** > **Module Configuration** page. Modules on this page are shown grouped by their certificate. Click **View Certificate** to see details about each certificate. A warning message will appear if the module certificate is expired, however this will not have any impact on security or module behavior. ![](install-upgrade-mod-imgs/2023-02-27_16-03-17.png) ## Third Party Modules Third Party modules are not produced by Inductive Automation. Ensure that you know who produced the code, and perform due diligence as you would with any other software vendor in accordance with organizational policy. Strategic Partners, such as Cirrus Link, and Premier Technology Providers, such as 4IR and Sepasoft, are trusted parties by Inductive Automation. However, their modules or services are created by separate groups and may need to be vetted separately from the Ignition platform. The [Module Showcase](https://inductiveautomation.com/moduleshowcase/) hosts Ignition modules written by the community. Authors are required to request certificates from Inductive Automation (IA). IA will remove modules with known problems or risk, but hosting does not require a high level of vetting. Your account representative may be able to provide more information on well-known companies. The bundled version of Java in Ignition has been upgraded from Java 11 to Java 17.0.8, which may impact third party module compatibility. Refer to third party module documentation for further communication about any end-user modifications that may be required.