diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md index 44d1d8f9929261a1817503e31147c347ff4c5b59..bbc1d259e1a6f8d7e64259e2bed8fb5579516ade 100644 --- a/doc/integration/kerberos.md +++ b/doc/integration/kerberos.md @@ -1,6 +1,16 @@ # Kerberos integration -GitLab can be configured to allow your users to sign with their Kerberos credentials. +## Overview + +[Kerberos][kerb] is a secure method for authenticating a request for a service in a +computer network. Kerberos was developed in the Athena Project at the +[Massachusetts Institute of Technology (MIT)][mit]. The name is taken from Greek +mythology; Kerberos was a three-headed dog who guarded the gates of Hades. + +## Use-cases + +- GitLab can be configured to allow your users to sign with their Kerberos credentials. +- You can use Kerberos to [prevent][why-kerb] anyone from intercepting or eavesdropping on the transmitted password. ## Configuration @@ -9,7 +19,6 @@ following prerequisites. You still need to configure your system for Kerberos usage, such as specifying realms. GitLab will make use of the system's Kerberos settings. - ### GitLab keytab 1. Create a Kerberos Service Principal for the HTTP service on your GitLab server. @@ -226,3 +235,6 @@ to a larger value in [the NGINX configuration][nginx]. [restart gitlab]: ../administration/restart_gitlab.md#installations-from-source [reconfigure gitlab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure [nginx]: http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers +[kerb]: https://web.mit.edu/kerberos/ +[mit]: http://web.mit.edu/ +[why-kerb]: http://web.mit.edu/sipb/doc/working/guide/guide/node20.html