Installation
Prerequisites
- Ignition 8.3.0 or higher (the module does not install on 8.1/8.2 gateways)
- Java 17 runtime (provided by the Ignition 8.3 platform)
- Network access to your Git remote repository (GitHub, GitLab, Bitbucket, Azure DevOps, etc.)
- For SSH authentication: an SSH key pair
Download
Download Git ModuleInstallation Steps
- Log in to your Ignition Gateway web interface
- Navigate to Config > Modules
- Click Install or Upgrade a Module
- Select the
Git.modlfile - Review and accept the license agreement
- The module installs automatically and registers its resource types
Upgrading
Upgrading to 2.0.0 (Ignition 8.3)
Version 2.0.0 is a major release rebuilt for the Ignition 8.3 platform:
- Ignition 8.3+ only. The module no longer installs on 8.1/8.2 gateways; stay on the 1.x line there.
- Java 17, matching the 8.3 platform runtime.
- Existing configuration is migrated automatically. On first startup the module imports your 1.x configuration — repository registrations, remotes, SSH keys, and HTTPS credentials — into Ignition 8.3's resource/config store. The one-time import is idempotent and clears the old records once migrated, so no manual re-entry is needed (unlike the AXONE-IO transition below).
Upgrading from the AXONE-IO version
If you previously ran the AXONE-IO version of this module (com.axone_io.ignition.git), note the following breaking changes:
This release is published as com.operametrix.ignition.git. Ignition treats it as a distinct module, so you must uninstall the AXONE-IO module before installing this one.
- Credentials are not migrated. Git credentials were previously stored inline per project/repo. They are now user-level: SSH keys and per-host HTTPS credentials are managed in the User Credentials dialog and referenced by remotes. The old inline credentials are not carried over — you must re-enter your SSH keys / HTTPS credentials after installing this version.
- Commit-author email is not migrated. The per-project commit email is gone; the commit author now comes from the Ignition user profile. Set the email on the Ignition user account if it isn't already.
Existing repository registrations (project ↔ repo, remotes) are preserved; only the credential and author-email configuration must be re-applied.
Verification
After installation:
- Verify the module appears in the modules list with Running status
- Open the Ignition Designer and verify the Git status bar appears at the bottom of the window
When opening a project in the Designer for the first time, the status bar shows a Configure button. Click it to launch the repository initialization wizard.
Network Requirements
Outbound (Ignition to Git Remote)
The Ignition gateway must be able to reach your Git remote repository:
| Protocol | Port | Description |
|---|---|---|
| HTTPS | 443 | For HTTPS-based Git remotes (GitHub, GitLab, Bitbucket, etc.) |
| SSH | 22 | For SSH-based Git remotes |
Ensure outbound access from the Ignition gateway to your Git hosting provider. No inbound connections are required — all Git operations are initiated by the gateway.
Dependencies
The Git module has no dependencies on other Ignition modules. It works with any Ignition installation running version 8.3.0 or higher.
Troubleshooting
| Issue | Solution |
|---|---|
| Module not appearing | Restart the Ignition gateway and check gateway logs |
| Module fails to install | Confirm the gateway is running Ignition 8.3.0 or higher |
| Git status bar not visible in Designer | Reopen the Designer; click Configure in the status bar to run the setup wizard |
| Conflict with AXONE-IO module | Uninstall the old com.axone_io.ignition.git module before installing |
| SSH connection failure | Verify the SSH key format and that port 22 is open to your Git host |
| HTTPS authentication failure | Verify the credential — many providers require personal access tokens instead of passwords |