Child pages
  • TeamCity Hub Plugin
Skip to end of metadata
Go to start of metadata

General Info

Vendor

JetBrains

License

TeamCity License

Type

free for TeamCity Professional and TeamCity Enterprise servers users, closed-source

Plugin Description

The plugin adds the ability to log in to TeamCity via JetBrains Hub, and allows for synchronization of user details from Hub to TeamCity: creating/deleting TeamCity users and updating TeamCity user data (username, display name, email, jabber, default VCS usernames, etc.).

Supported Environment

The plugin requires TeamCity server to be run with Java version 1.7+. If your TeamCity server uses Java 1.6, the plugin will not be loaded.

Download and Installation Instructions

Download plugin for corresponding TeamCity version:

TeamCity versionDownload link
TeamCity 10.0.xDownload
TeamCity 9.1.xDownload

 

Install the plugin as usual. 

After the server restart, you can view the enabled Hub authentication on the Administration | Authentication page and manage the integration with Hub using the Administration | Hub Settings page.

Authentication

Hub plugin adds two JetBrains Hub authentication modules to TeamCity: 

  • JetBrains Hub allowing authentication via JetBrains Hub from the TeamCity login form and IDE 
  • JetBrains Hub Single Sign-On enabling Single sign-on / sign out via JetBrains Hub.

You can view the currently enabled authentication modules on the Administration | Authentication page. 

Icon

Removing the JetBrains Hub modules will disable authentication via Hub.


Usage

 Enabling / Disabling integration with Hub 

  1. On the Administration | Hub Settings page provide the Hub URL of the following format http://<HubHOST>:<port>/hub.

  2. Сlick Register TeamCity service in Hub.  >

    Icon

    Note that the Guest user in Hub needs to be allowed (unbanned) for the TeamCity service registration in Hub.

  3. You will be redirected to the Services page in Hub. Verify the TeamCity Hub service using the Trust button. 

  4. After you trust the TeamCity service in Hub, return to the TeamCity Web interface to configure user synchronization. 


Filtering Users


If you want to limit the number of Hub users accessing TeamCity, you can use the Hub user filter on the Miscellaneous tab. The plugin will process only the users matching the filter: the selected Hub users will be synchronized when synchronization is enabled and will be able to log in to TeamCity via Hub afterwards. To synchronize all Hub users with TeamCity, leave the filter blank. 

Synchronizing Users with Hub 

Using the Administration | Hub Settings| Synchronization tab of the server settings, you can enable, configure and run on-demand user synchronization.  

TeamCity supports one-way synchronization with Hub: the data is retrieved from Hub and is stored in the TeamCity database. Periodically, TeamCity fetches data from Hub and updates users in TeamCity.

Synchronization with Hub in TeamCity allows you to:

  • Retrieve the user's profile data from Hub
  • Automatically create and remove users in TeamCity based on the information retrieved from Hub

The following options are available:

SettingDescription
Enable users synchronizationAllows importing users and their details from Hub to TeamCity.
Update user profiles in TeamCityThe user name, email and VCS usernames in TeamCity will be updated with data from the user profile in Hub on the first synchronization. If any of this data will be later modified in TeamCity, the changed data will not be imported from Hub on the next synchronization. 
Create user accounts in TeamCityNew users (those existing in Hub but not existing in TeamCity) matched by the users filter will be imported to TeamCity with their login details, emails and VCS usernames. All the imported users will have a Hub ID in TeamCity. 
If a user with the same name exists in TeamCity and Hub, the user is not synchronized until they login to TeamCity via Hub. The existing TeamCity users with no match in Hub will remain intact.

 

Delete user accounts from TeamCity

If a user account is deleted in Hub (banned/ merged) or is not matched by the filter anymore, it will also be deleted in TeamCity as well.

 


Clicking Synchronize now  launches synchronization manually. After the synchronization is finished, the results will be reported on the page. 

Using several URLs for TeamCity server

If your TeamCity server is available under several URLs (in addition to the URL configured on Administration | Global Settings in TeamCity UI), you will need to add extra URLs manually to the TeamCity service in Hub as valid redirect URLs.For each URL, add "<TeamCity server URL>/hubPlugin/login.html" line

Enabling access to TeamCity for Hub Dashboard

Hub dashboard retrieves data from TeamCity with help of TeamCity REST API. As such CORS should be configured on the TeamCity side. The following TeamCity internal properties should be set:

Where <dashboard hostname> should be hostname with protocol and port, for example: http://myinternalwebpage.org.com:8080

Icon

You need to restart TeamCity server after changing rest.cors.optionsRequest.allowUnauthorized internal property.


Plugin Development Status

In active development. 
Everyone is encouraged to try the plugin, however issues can be uncovered.

If you believe you've faced a bug: Issue Tracker (project: TeamCity)
If you want to ask a question or discuss: Forum
Any of the above, but you do not want it to be publicly accessible: Online Form or Feedback email

 

 

  • No labels