Authentication Settings

Out-of-the-box TeamCity Enterprise edition supports three authentication schemes:

• Default Authentication
• Windows Domain Authentication
  • Windows Domain Authentication on Unix-like computers
• LDAP Integration (separate page)

TeamCity Professional edition only supports TeamCity Default Authentication.

<auth-type>
    <!-- Active login module class, see below -->
    <login-module class="jetbrains.buildServer.serverSide.impl.auth.LDAPLoginModule" />
    <!-- Welcome message displayed to users on login form -->
    <login-description>Welcome to TeamCity, your team building environment!</login-description>
    <!-- Whether anonymous "view-only" logins are allowed (true|false) -->
    <guest-login allowed="true" />
    <!-- Allow users to self-register (only for modules which support this feature, e.g. DefaultLoginModule) (true|false) -->
    <free-registration allowed="false" />
</auth-type>

Authentication type is defined by the login module, welcome message and the possibility to use anonymous login. Built-in login modules are:

• jetbrains.buildServer.serverSide.impl.auth.DefaultLoginModule for Default Authentication
• jetbrains.buildServer.serverSide.impl.auth.NTDomainLoginModule for Windows Domain Authentication
• jetbrains.buildServer.serverSide.impl.auth.LDAPLoginModule for LDAP Authentication

  TeamCity extensibility note Any implementation of javax.security.auth.spi.LoginModule can be used, provided it is registered via jetbrains.buildServer.serverSide.auth.LoginModuleDescriptor bean.

Default Authentication

Configuration of <TeamCity data directory>/config/main-config.xml:

<auth-type>
    <login-module class="jetbrains.buildServer.serverSide.impl.auth.DefaultLoginModule" />
    <!-- Welcome message displayed to users on login form -->
    <login-description>Welcome to TeamCity, your team building environment!</login-description>
    <!-- Whether anonymous "view-only" logins are allowed (true|false) -->
    <guest-login allowed="true" />
    <!-- Allow users to self-register (only for modules which support this feature, e.g. DefaultLoginModule) (true|false) -->
    <free-registration allowed="true" />
</auth-type>

Users database is maintained by TeamCity. New users are added by TeamCity administrator (in administration area section) or user are self-registered if <free-registration allowed="true" /> tag is specified.

Windows Domain Authentication

Configuration of <TeamCity data directory>/config/main-config.xml:

<auth-type>
    <login-module class="jetbrains.buildServer.serverSide.impl.auth.NTDomainLoginModule" />
    <!-- Welcome message displayed to users on login form -->
    <login-description>Welcome to TeamCity, your team building environment!</login-description>
    <!-- Whether anonymous "view-only" logins are allowed (true|false) -->
    <guest-login allowed="true" />
</auth-type>

Windows Domain Authentication is supported if TeamCity server is installed under Windows 2000, Windows XP or Windows Server 2003, as well as under Unix-like OS.

Prior to TeamCity 3.1, all Windows domain users that can log on to the machine running TeamCity server can also log in to TeamCity using the same credentials.

To log in to TeamCity users should provide their user name in the form DOMAIN\user.name and their domain password. Starting with the 3.1 version, TeamCity also supports logging in using <username>@<domain> syntax. It is also possible to log in using only a username if the domain is added to the <TeamCity data directory>/config/ntlm-config.properties file.

Windows Domain Authentication on Unix-like Computers

TeamCity supports Windows Domain Authentication on Unix-like computers. For this to work, check the <TeamCity data directory>/config/ntlm-config.properties file and make sure the following line is commented out.

# ntlm.compatibilityMode=true

Please refer to the http://jcifs.samba.org/src/docs/api/ page for information about other supported properties.

If you want to use the NT domain authentication available in TeamCity version prior to 3.1, ensure the line ntlm.compatibilityMod=true is present and not commented in the ntlm-config.properties file.

LDAP Authentication

Please refer to the corresponding section.

See Also:

• Concepts: Authentication Scheme
• UI Reference: Administration