Skip to main content

Configuration

Repository Initialization​

When opening a project in the Designer for the first time, the status bar shows a Configure button. Click it to launch the initialization wizard. The wizard is a simple two-path flow: Choose, then either Remote or Local.

Set up credentials first

You can open the User Credentials dialog (the user icon in the status bar) before initializing to add your SSH keys or HTTPS credentials. The remote step of the wizard then lets you pick one directly.

Clone from Remote​

  1. Choose the Remote path
  2. Enter the repository URI (HTTPS or SSH)
  3. Pick a saved credential from the dropdown — it is filtered by the URI scheme (SSH keys for git@… URIs, HTTPS credentials for https://… URIs). Use Configure… to add one inline if needed.
  4. Click to clone — the module clones the repository and imports the project

Initialize Locally​

  1. Choose the Local path
  2. Confirm — no fields are required
  3. The module creates a local Git repository with an initial commit
  4. A remote can be added later via the Remotes manager
Commit author email

The commit author email comes from your Ignition user profile, not from a per-project setting. Make sure your Ignition user account has an email address configured.

User Credentials​

Credentials are user-level and shared across all your projects and remotes. Open the User Credentials dialog by clicking the user icon in the Designer status bar ("Manage Git Credentials"). It manages two kinds of credential:

SSH Keys​

ParameterTypeDescription
Key Name *TextA label to identify this key in the credential picker
SSH Key *TextThe SSH private key content

SSH transport uses Apache MINA sshd.

HTTPS Credentials​

ParameterTypeDescription
Host PatternTextAn organizational label to disambiguate credentials in the picker (e.g. github.com)
Username *TextGit username
Password / Token *TextPassword or personal access token (stored encrypted)

The dialog shows provider hint text for the common hosts:

  • GitHub / GitLab — use a Personal Access Token (PAT) as the password
  • Azure DevOps — use a PAT (the username may be left empty)
  • Bitbucket — use an App Password
Personal Access Tokens

Most Git hosting providers no longer accept account passwords for Git operations. Generate a personal access token (or app password) with appropriate repository permissions and use it as the password.

Host Pattern is a label only

Host Pattern is purely an organizational label in the credential picker — authentication never matches on it. Remotes resolve their credential strictly by the credential you select for them.

Remote Management​

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

Adding a Remote​

  1. Click Add Remote
  2. Enter the remote name (e.g. origin, upstream)
  3. Enter the remote URL
  4. Select the saved credential to use for this remote (or open User Credentials inline to create one)
  5. Save

Editing a Remote​

  1. Select the remote in the list
  2. Edit the URL or the selected credential
  3. Save

Removing a Remote​

  1. Select the remote in the list
  2. Remove
Per-Remote Credentials

Each remote references one saved credential by id. This lets you push to different Git providers (e.g. GitHub and GitLab) with different authentication, while the underlying SSH keys and HTTPS credentials remain centrally managed in the User Credentials dialog. The authentication type (SSH vs HTTPS) is determined automatically from the remote URL.

Authentication​

The module selects the authentication method automatically from the remote URL:

  • HTTPS — when the URL starts with http:// or https://, the remote's referenced HTTPS credential (username + password/token) is used.
  • SSH — when the URL uses SSH format (e.g. git@github.com:user/repo.git), the remote's referenced SSH key is used.

Every remote must reference an explicit credential. If a remote has no credential set, or the referenced credential has been deleted, remote operations fail with a clear message asking you to pick a credential in the Remotes popup. Local-only repositories (no remote) degrade gracefully — remote operations show a friendly warning instead of failing.