Skip to main content
Connectors allow Acrity to work with code providers that should not be accessed directly by the Acrity cloud. Use Console > Connectors to create a connector, generate installation secrets, download deployment artifacts, track liveness, and associate repositories.
Connectors require a Workspace admin (platform admins also have access). Roles are fixed capability sets defined by Acrity, so no other role can create, edit, or revalidate a connector.

​
When to use

Use connectors when:
  • the VCS is on a private network;
  • the provider is self-hosted;
  • VCS access must originate from a network controlled by the organization;
  • internal policies prevent VCS tokens from being stored in external services;
  • you need to go through a corporate proxy or private CA.
For SaaS providers with official installation, evaluate Console > Connected Apps first.

​
How it works at a high level

  1. A Workspace admin creates the connector in the Console.
  2. The Console displays installation secrets once.
  3. The team installs the local component in the organization’s environment.
  4. The connector opens an egress-only outbound connection to Acrity and reaches the private VCS locally.
  5. Repositories can then be discovered and associated through the Console.
The Acrity cloud holds no VCS credentials. Only the local connector, running inside your network, holds the credentials for your private VCS. The connector opens an egress-only, secure outbound connection to Acrity, so you do not need to open any inbound ports in your network.
Security, retention, and data handling details are in Security > Data handling and Security > Credentials and tokens.

​
Create a connector

1

Open connectors

Go to Console > Connectors.
2

Start wizard

Choose to create a new connector.
3

Enter data

Fill in name, provider, and instance base URL when applicable.
4

Generate secrets

Generate the connector token and relay secret when prompted.
5

Store values

Copy and store the values in a secure vault. They are shown only once.
6

Download artifact

Download the installation format compatible with the organization’s environment.
7

Install and validate

Install the connector, wait for the heartbeat, and run Revalidate when available.
Connectors page listing local connectors and their health status
The connector token is stored by Acrity only as a SHA-256 hash. Because Acrity keeps no recoverable copy of the secret, it can never be displayed again after creation. If you lose it, generate a new token and update the local installation.

​
Main fields

​
Health states

The Console shows a health state for each connector, based on the heartbeat and the most recent Revalidate. Use Revalidate to force an immediate connectivity and credential check instead of waiting for the next automatic heartbeat. After you correct an issue, run Revalidate to confirm the connector returns to the connected state.

​
Download installation artifact

After creating the connector:
  1. Go to Console > Connectors.
  2. Open the connector.
  3. Choose the deploy format supported by your infrastructure.
  4. Download the artifact.
  5. Deliver the package to the team responsible for local installation.
Do not publish artifacts with secrets in shared repositories. Treat configuration files as sensitive material.

​
Associate repositories

When the connector is online:
  1. Go to Console > Repositories > Connect repository.
  2. Choose the connector as the VCS access source.
  3. Select or enter the target repositories.
  4. Complete branch, PM, and review settings.
  5. Save and validate the repository status.

​
Rotate secrets

Rotate secrets when:
  • someone with access to the secret left the team;
  • exposure is suspected;
  • internal policy requires periodic rotation;
  • the local environment was recreated;
  • the connector will move to different infrastructure.
After generating new secrets, update the local installation and run Revalidate to confirm the connector returned to the connected state.

​
Common issues

​
Best practices

  • Install connectors in infrastructure administered by the organization.
  • Store secrets in a secure vault.
  • Use service accounts with minimum scope.
  • Monitor the heartbeat and Console alerts.
  • Revoke unused connectors.
  • Document internally who operates each connector.