Installation
These instructions cover the 1.x line of the module (com.operametrix.ignition.git) for Ignition 8.1. For Ignition 8.3, use the 8.3 documentation.
Prerequisites
- Ignition 8.1.0 or higher
- 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 verifies its persistent record schema on the gateway
Migrating 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:
- Separate module ID. 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. The old inline configuration is not carried over — re-enter your SSH keys and HTTPS credentials after installing, in the User Credentials dialog.
- 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) are preserved; only the credential and author-email configuration must be re-applied.
The schema upgrade does not carry over credentials or commit-author email from the AXONE-IO version. Plan to re-add your SSH keys and HTTPS credentials in the User Credentials dialog after installing.
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 an unregistered project in the Designer, the status bar shows a Configure button. Click it to launch the repository setup wizard. See Configuration.
Network Requirements
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 8.1 installation and is compatible with Maker Edition.
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.1.0 or higher |
| Git status bar not visible in Designer | Reopen the Designer; click Configure in the status bar to run the setup wizard |
| 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 |