Skip to main content
Version: 8.3

Installation

Prerequisites

  • Ignition 8.3.0 or higher (the module does not install on 8.1 gateways)
  • Network access to your Git remote repository (GitHub, GitLab, Bitbucket, Azure DevOps, etc.)
  • For SSH authentication: an SSH key pair
  • For CI/CD deployments: a gateway URL your Git provider can reach — see Network Requirements

Download

Download Git Pro

Installation Steps

  1. Log in to your Ignition Gateway web interface
  2. Navigate to Platform > System > Modules
  3. Click Install or Upgrade a Module
  4. Select the Git-Pro.modl file
  5. Review and accept the license agreement
  6. The module installs automatically and registers its resource types
Module scopes

The module ships Gateway and Designer scopes; the Versioning and CI/CD web pages are bundled into the Gateway scope. There are no additional modules to install.

Upgrading

Upgrading from the free Git module

Git Pro carries the same module id as the free Git module (com.operametrix.ignition.git). Install Git-Pro.modl over it — there is nothing to uninstall. Registered projects, credentials, remotes, and the Versioning repository are preserved.

Two connection-security changes can affect remotes that work today:

  • TLS certificates are verified. A remote served over HTTPS with a self-signed or otherwise untrusted certificate may stop connecting until you tick Trust self-signed certificate on that remote.
  • SSH host keys are verified. The first connection to each SSH host asks you to accept its fingerprint.

See Configuration → Connection Security for both.

Maker Edition

The free Git module runs on Maker Edition; Git Pro does not.

Upgrading from Ignition 8.1

Configuration is migrated automatically

The 1.x line stored its configuration as SimpleORM PersistentRecord rows in the gateway's internal database. 8.3 stores it as config resources. On first startup the module runs a one-time importer that moves the rows across:

1.x recordBecomes
Project registrationsgit-project resources
Repo usersgit-repo-user resources
SSH keysgit-user-ssh-key resources
HTTPS credentialsgit-user-https-credential resources
Remote credentialsgit-remote-credential resources

Numeric ids — and therefore the relationships between the records — are preserved exactly. The import is idempotent: a legacy row is only migrated if no resource with the same id exists yet, each migrated row is deleted from its old table, and a .git-module-legacy-migrated marker in the gateway data directory stops it running again. On a fresh 8.3 install there are no legacy tables and the whole step is skipped.

Schema changes

  • Secrets are re-encrypted. SSH private keys and HTTPS passwords/tokens are re-encrypted into the 8.3 secret format during the import, so key material is never written to the resource JSON in clear. Going forward both can also reference an Ignition Secret Provider entry instead of holding the value inline — see Configuration → Secret Providers.
  • Remote URIs are not migrated. The 1.x project record carried the remote URI; .git/config in the working repository is now the source of truth, and the resource only carries identity. Existing checkouts keep their remotes; nothing to re-enter.

New in 2.x

Gateway Configuration Versioning (Platform > System > Versioning) has no 8.1 equivalent — it is opt-in and initialises its own repository at <dataDir>/.git. See Usage.

tip

Check the gateway logs after the first 8.3 startup. The importer logs how many legacy rows it migrated, and logs an error per row it could not convert — those credentials need re-entering by hand.

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:

Uninstall the AXONE-IO module first

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:

  1. Verify Git Pro appears in the modules list with Running status
  2. Open the Ignition Designer and verify the Git status bar appears at the bottom of the window
  3. In the gateway, verify Platform > System > CI/CD opens
First Launch

On a project with no repository yet, the status bar shows a Configure button — see Configuration → Repository Initialization.

Network Requirements

Outbound (Ignition to Git Remote)

The Ignition gateway must be able to reach your Git remote repository. Git servers conventionally listen on the ports below, though your host may differ:

ProtocolTypical PortDescription
HTTPS443For HTTPS-based Git remotes (GitHub, GitLab, Bitbucket, etc.)
SSH22For SSH-based Git remotes
Firewall Configuration

Ensure outbound access from the Ignition gateway to your Git hosting provider. The gateway Configuration Versioning feature uses the same outbound access when you sync its config repo to a remote.

Inbound (Git provider to Ignition) — CI/CD only

Designer and Versioning workflows need no inbound access. CI/CD deployments do: the provider must reach the gateway on its Gateway External URL (set when connecting a provider) for two endpoints.

EndpointUsed for
<External URL>/data/git-config/devops/oauth/callbackCompleting the provider connection (OAuth redirect / GitHub App setup)
<External URL>/data/git-config/devops/webhookPush notifications that trigger deployments

The CI/CD gateway also calls the provider's API outbound (github.com, gitlab.com, gitea.com, or your self-hosted instance) to list repositories and branches, register push hooks, and obtain tokens.

Both endpoints are unauthenticated at the Ignition level and verify each request themselves: the callback against a single-use state token that expires, and the webhook against the provider's signature or secret token.

Dependencies

Git Pro has no dependencies on other Ignition modules. It works with any Ignition installation running version 8.3.0 or higher.

Troubleshooting

IssueSolution
Module not appearingRestart the Ignition gateway and check gateway logs
Module fails to installConfirm the gateway is running Ignition 8.3.0 or higher
Git status bar not visible in DesignerReopen the Designer; click Configure in the status bar to run the setup wizard
Conflict with AXONE-IO moduleUninstall the old com.axone_io.ignition.git module before installing
SSH connection failureVerify the SSH key format and that port 22 is open to your Git host
HTTPS authentication failureVerify the credential — many providers require personal access tokens instead of passwords
HTTPS remote stopped connecting after installing Git ProThe server's certificate is self-signed or untrusted — see Trust self-signed certificate
Git Pro will not install on a Maker Edition gatewayGit Pro is not Maker-compatible; use the free Git module there