Using Custom Omniauth Providers

GitLab uses Omniauth for authentication and already ships with a few providers preinstalled (e.g. LDAP, GitHub, Twitter). But sometimes that is not enough and you need to integrate with other authentication solutions. So of there is an Omniauth provider for it, this is meant to help you set it up for GitLab.

Steps

This are fairly general and you will need to figure out the exact details from the Omniauth provider's documentation.

• Add gem "omniauth-your-auth-provider" to the Gemfile
• Run sudo -u gitlab -H bundle install to install the new gem(s)
• Add provider specific configuration options to your config/gitlab.yml (you can use the auth providers section of the example config as a reference)
• Add icons for the new provider into the vendor/assets/images/authbuttons directory (you can find some more popular ones over at https://github.com/intridea/authbuttons)
• Restart GitLab

Examples

If you have successfully set up a provider that is not shipped with GitLab itself, please let us know. You can help others by reporting successful configurations and probably share a few insights or provide warnings for common errors or pitfalls by sharing your experience in the public Wiki. While we can't officially support every possible auth mechanism out there, we'd like to at least help those with special needs.