GitKraken Desktop Documentation

Contact support  
GitKraken Status  

Configure GitKraken Self-Hosted Server

After installing GitKraken Self-Hosted Server (AKA Enterprise Self-Hosted), you are ready to configure the Server.

Server License

Browse to your GitKraken Self-Hosted server:

Select Browse for license file and browse to the the license file that was provided to you with the GitKraken Self-Hosted installation files. Once selected, the license file will show you the details of your license:


Select the Authentication Config for your server:

  • Built-in: Users will be authenticated using an email address and password
  • LDAP: Users will be authenticated using LDAP

If you’re using Built-in authentication, jump to the next step.

LDAP Configuration

Provide the hostname and port for your LDAP server.

Select the encryption method. This should correspond with the port entered above.

Assign the Base Distinguished Names, Access Group, and Admin Group Common Names.

  • Base Distinguish Names – These are the top-level locations used to search in your directory

  • Access Group Common Names – Used to specify the group name whose users will be granted licenses for GitKraken. If no access group is specified, all users found will be granted a license.

  • Admin Group Common Names – Used to specify the group name whose users will be granted admin access to the GitKraken Self-Hosted site. If no admin group is specified, no users found will be granted admin rights.

Assign the user attributes needed to identify LDAP users.

  • Username Attribute (Required) – Used to map to the user’s username in GitKraken.

  • Email Attribute (Required) – Used to map to the user’s email in GitKraken.

  • Name Attribute – Used to map to the user’s name in GitKraken.

Provide the Distinguished Name for the user that will be used to search LDAP for users and groups.
This can be a separate user that only has rights to search LDAP.
This user is required when anonymous binding in LDAP is disabled.

Note: The Domain Search Password field will display blank, even when the field is set.

Enable the sync server, if desired, and set the sync interval. The sync server will automatically search LDAP at the set interval and update GitKraken licenses accordingly.

If the sync server is not enabled, you will need to manually manage user accounts.

SMTP Server

An SMTP server is required, unless LDAP authentication is in use.

Set the SMTP server IP address or hostname, the SMTP port, and the From Address. If your SMTP server needs a secure connection, check the box for secure protocols and provide the username and password, if needed. The test connection button will allow you to verify the connection information is accurate:

Super User

The super user will be the Owner of the GitKraken Self-Hosted license. The super user does not consume a license, cannot log into GitKraken Desktop, and cannot be changed or viewed from the account site user management page.

Note: Visit the upgrade page to see how to reset the super user password.

Configuration is complete! You should now be at the ‘Manage Users’ screen where you can begin adding users to GitKraken Self-Hosted.

Adding Users

To add a user click on the Add user button and provide the email address of the user:

By default, users can create an account themselves from the GitKraken Self-Hosted site. If you don’t want to allow this functionality you can click the Registration tab on the left.

Have feedback about this article? Did we miss something? Let us know!
On this page