Configuring Connections

Azure DevOps

A connection to Azure DevOps Services (or Azure DevOps Server, formerly Team Foundation Server) can be used to:

• create a project from URL;

• create a VCS root from URL;

• create a TFS VCS root;

• integrate with a Team Foundation Work Items issue tracker;

• automatically apply an access token when configuring Commit Status Publisher for Git repositories.

Before configuring this connection, you need to sign in to your Azure DevOps account and create a personal access token with All scopes as described here

Then, go back to the connection form in TeamCity:

1. Enter your Azure server URL:

   • https://{account}.visualstudio.com for Azure DevOps

   • https://{server}:8080/tfs/ for VSTS

2. Paste your Azure token.

3. Save the connection.

An Azure DevOps icon will become active in several places where a repository URL can be specified. Click it to authorize TeamCity in your Azure profile. TeamCity will be granted full access to all the Azure resources available to you. If you configure multiple Azure connections, the server URL will be displayed next to each icon, so it is easier to distinguish the server in use.

Bitbucket Cloud

A connection to Bitbucket Cloud can be used to:

• create a project from Bitbucket URL;

• create a VCS root from URL;

• create a Mercurial VCS root;

• integrate with a Bitbucket Cloud issue tracker;

• enable BitBucket Cloud authentication.

The Bitbucket Cloud connection form provides multiple parameters. You need to use them for creating a new OAuth consumer in Bitbucket.

After the consumer is created:

1. Copy its key and secret.

2. Go back to the connection form in TeamCity.

3. Paste the key and secret.

4. Save the connection.

A Bitbucket icon will become active in several places where a repository URL can be specified. Click it to authorize TeamCity in your Bitbucket profile. TeamCity will be granted access to your public repositories. For private repositories, you will need to provide Bitbucket credentials to be used for authentication by TeamCity, as Bitbucket Cloud does not provide non-expiring access tokens. See the related discussion. If you configure multiple Bitbucket connections, the server URL will be displayed next to each icon, so it is easier to distinguish the server in use.

GitHub

There are two types of GitHub connections: GitHub Enterprise and GitHub.com. Choose it depending on your GitHub account type.

A connection to GitHub can be used to:

• create a project from GitHub URL;

• create a VCS root from URL;

• create a Git VCS root;

• integrate with a GitHub issue tracker;

• enable GitHub.com authentication.

The GitHub connection form provides multiple parameters. You need to use them to create a new OAuth application in GitHub.

After the app is created:

1. Copy its client ID and secret.

2. Go back to the connection form in TeamCity.

3. Paste the GitHub server URL (only for Enterprise) and the app ID and secret.

4. Save the connection.

If you use a GitHub Enterprise server with HTTPS, you need to also upload its HTTPS certificate as described here.

A GitHub icon will become active in several places where a repository URL can be specified. Click it to authorize TeamCity in your GitHub profile. TeamCity will be granted full control of your private repositories and get the Write repository hooks permission. If you configure multiple GitHub integrations, the server URL will be displayed next to each icon, so it is easier to distinguish the server in use.

GitLab

There are two types of GitLab connections: GitLab CE/EE and GitLab.com. Choose it depending on your GitHub account type.

A connection to GitLab can be used to:

• create a project from GitLab URL;

• create a VCS root from URL;

• enable GitLab.com authentication.

The GitLab connection form provides multiple parameters. You need to use them to create a new OAuth application in GitLab.

After the app is created:

1. Copy its client ID and secret.

2. Go back to the connection form in TeamCity.

3. Paste the GitLab server URL (only for CE/EE) and the app ID and secret.

4. Save the connection.

If you use a GitLab CE/EE server with HTTPS, you need to also upload its HTTPS certificate as described here.

A GitLab icon will become active in several places where a repository URL can be specified. Click it to authorize TeamCity in your GitLab profile. TeamCity will be granted access to your repositories. If you configure multiple GitLab connections, the server URL will be displayed next to each icon, so it is easier to distinguish the server in use.

Docker Registry

A connection to Docker Registry can be used to:

• sign in to an authenticated Docker registry before running a build / sign out after the build;

• clean up published images after the build.

See more information in the dedicated article.

Amazon ECR

An Amazon ECR (Elastic Container Registry) connection allows accessing private AWS registries. With its help, the Docker Support build feature can store Docker images produced by a build to a private registry.

Connection settings:

Slack

This type of connection is used to enable notifications via Slack.

Before configuring a Slack connection, you need to create a Slack app with the following bot token scopes: channels:read, chat:write, im:read, im:write, users:read, team:read, groups:read. You can add these in Features | OAuth & Permissions | Scopes of your Slack app.

To ensure your TeamCity server can connect to Slack, specify all the possible endpoint addresses of the server as Redirect URLs in Features | OAuth & Permissions. In most cases, it would be enough to specify the Server URL set in Global Settings in TeamCity. However, if you use a proxy for your TeamCity server but access this server directly, the authentication in Slack might not work unless the server's IP address is also specified in Redirect URLs.

Now you can return to TeamCity, add a new Slack connection, and enter the following connection parameters:

• client ID and secret from the app's Basic Information page;

• a bot user token of your app.

Save the connection and proceed with adding a Notifier build feature.

JetBrains Space

This type of connection can be used to publish build statuses in JetBrains Space with the help of Commit Status Publisher.

Before configuring this connection, you need to create a dedicated application in JetBrains Space:

1. Go to Administration | Applications and click New application.

2. Enter a convenient name (for example, TeamCity-to-Space publisher) and save the application.

3. Open the app's Requested rights tab and enable the Git Repositories | Report external check status permission.

4. Open the Authentication tab and enable Client Credentials Flow.

5. In the Authentication tab, copy the app's Client ID and Client secret.

6. Open the Authorization tab and add projects where this app will be authorized. Alternatively, you can authorize this app in the settings of every required project.

Now you can return to TeamCity, add a new JetBrains Space connection, and enter the following connection parameters:

• URL of the Space server;

• client ID and secret of your Space application.

Save the connection and proceed with adding a Commit Status Publisher build feature.

NPM Registry

This type of connection allows accessing a private npm registry during a build.

Connection settings:

Save the connection and proceed with adding an NPM Registry Connection build feature.

Perforce Administrator Access

This type of connection allows processing task streams on your Perforce server. In the connection settings, enter the host and user credentials for accessing the Perforce server (the user must have the admin permission).