Configuration

Repository Initialization

When opening a project in the Designer for the first time, the status bar shows "Not configured". Click on it to launch the initialization wizard.

Clone from Remote

1. Select Yes, clone from remote
2. Enter the repository URI (HTTPS or SSH)
3. The wizard detects the protocol and shows the appropriate credential fields:
   • HTTPS: username and password/token
   • SSH: SSH private key
4. Enter your email address (used as Git commit author)
5. Click Clone — the module clones the repository and imports the project

Initialize Locally

1. Select No, initialize locally
2. Enter your email address
3. Click Initialize — the module creates a local Git repository with an initial commit
4. A remote can be added later via the Remotes manager

---

Gateway Configuration

The module adds configuration pages to the Ignition Gateway web interface under Config > Git.

Project Configuration

Maps Ignition projects to Git remote repositories.

Parameter	Type	Description
Project Name *	Text	Ignition project name
URI	Text	Git remote URL (leave empty for local-only repositories)

User Configuration

Maps Ignition users to Git commit authors and credentials.

Parameter	Type	Description
Ignition User *	Text	Ignition user name
Email *	Text	Git commit author email address
Username	Text	Git username (for HTTPS authentication)

* Required fields

---

Remote Management

Manage multiple remotes (e.g., "origin", "upstream") from the Designer status bar by clicking the Remotes button.

Adding a Remote

1. Click Add Remote
2. Enter the remote name (e.g., origin, upstream)
3. Enter the remote URL
4. Configure credentials for this remote:
   • HTTPS: username and password/token
   • SSH: SSH private key
5. Click Save

Editing a Remote

1. Select the remote in the list
2. Click Edit
3. Modify the URL or credentials
4. Click Save

Removing a Remote

1. Select the remote in the list
2. Click Remove

Per-Remote Credentials

Each remote has its own set of credentials per user. This allows you to push to different Git providers (e.g., GitHub and GitLab) with different authentication methods.

---

User Identity

Configure your Git commit author identity by clicking the user icon in the Designer status bar.

Parameter	Type	Description
Email *	Text	Email address used in Git commits

The status bar shows a verified icon when the user identity is configured, or an unverified icon when it is not.

---

Authentication

The module supports two authentication methods, detected automatically from the remote URL:

HTTPS Authentication

Used when the remote URL starts with http:// or https://.

Parameter	Type	Description
Username *	Text	Git username
Password *	Text	Password or personal access token

Personal Access Tokens

Most Git hosting providers (GitHub, GitLab, Bitbucket) now require personal access tokens instead of passwords. Generate a token with appropriate repository permissions.

SSH Authentication

Used when the remote URL uses SSH format (e.g., git@github.com:user/repo.git).

Parameter	Type	Description
SSH Key *	Text	SSH private key content

SSH Key Format

Paste the full content of your SSH private key. The module uses Apache MINA sshd for SSH transport.

---

Commissioning

The module supports automated deployment via a commissioning configuration file, loaded on gateway startup.

Configuration Parameters

Parameter	Type	Description
repoURI	Text	Repository URL to clone
repoBranch	Text	Branch to checkout after clone
ignitionProjectName	Text	Target Ignition project name
ignitionUserName	Text	Ignition user for the operation
gitUsername	Text	Git username (for HTTPS)
userPassword	Text	Git password or token (for HTTPS)
sshKey	Text	SSH private key (for SSH)
userEmail	Text	Git commit author email
importImages	Boolean	Import image resources
importTags	Boolean	Import tag configurations
importThemes	Boolean	Import theme resources
initDefaultBranch	Text	Initial branch name

This enables fully automated initialization: place the configuration file, start the gateway, and the project is automatically cloned and configured.