General Info
Vendor | JetBrains |
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.).
Versions Compatibility
The current plugin version is compatible with TeamCity 9.1+ and Hub 1.0.
Supported Environment
The plugin requires Java version 1.7+
Download and Installation Instructions
Download hub-plugin.zip and install the plugin as described here.
After the server restart, the integration with Hub is managed using the Administration | Hub Settings page.
Usage
Enabling / Disabling integration with Hub
On the Administration | Hub Settings page provide the Hub URL of the following format
http:/HubHOST:port/hub.Сlick Register TeamCity service in Hub. You will be redirected to the Services page in Hub.
Verify the TeamCity Hub service using the Trust button.
This action will also enable authentication to TeamCity via Hub: the JetBrains Hub authentication preset appears on the Authentication page in TeamCity Web UI, where it can be manually disabled/enabled.After you trust the TeamCity service in Hub, return to the TeamCity Web UI to configure user synchronization. The Synchronization and Miscellaneous tabs appear on the Hub Settings page in TeamCity Administration UI once integration with Hub is enabled.
Filtering Users
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:
| Setting | Description |
|---|---|
| Enable users synchronization | Allows importing users and their details from Hub to TeamCity. |
| Update user profiles in TeamCity | The 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 TeamCity | New users (those existing in Hub but not existing in TeamCity) matched by the filter on the Miscellaneous tab 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. On login, the user acquires a Hub ID in TeamCity and the user’s details are synchronized.
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 on the Miscellaneous tab, it will also be deleted in TeamCity. |
Remember to Save the configured settings before starting synchronization.
Clicking Synchronize now launches synchronization manually. After the synchronization is finished, the results will be reported on the page.
The synchronized users will be able to login to TeamCity via Hub.
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