diff options
| author | David Ostrovsky <david@ostrovsky.org> | 2014-07-04 23:28:21 +0200 |
|---|---|---|
| committer | David Ostrovsky <david@ostrovsky.org> | 2014-07-07 10:47:20 +0200 |
| commit | f989cf3549193157d988c38f2f81c85329f719ad (patch) | |
| tree | 1939e330f4a0629a2ea9750ea3bb57e793823009 /src/site | |
| parent | 1ad355302a3daf0962f8e20538f6b4c4a9c8329a (diff) | |
| download | gitblit-ticket/138.tar.gz gitblit-ticket/138.zip | |
GitHub OAuth login for GitBlitticket/138
Diffstat (limited to 'src/site')
| -rw-r--r-- | src/site/setup_authentication.mkd | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/src/site/setup_authentication.mkd b/src/site/setup_authentication.mkd index 02d1be70..10c41ec3 100644 --- a/src/site/setup_authentication.mkd +++ b/src/site/setup_authentication.mkd @@ -4,6 +4,7 @@ By default, Gitblit stores and authenticates all users against `users.conf`. Ho Gitblit supports additional authentication mechanisms aside from it's internal one.
+* GitHub OAuth
* LDAP authentication
* Windows authentication
* PAM authentication
@@ -12,6 +13,43 @@ Gitblit supports additional authentication mechanisms aside from it's internal o * Salesforce.com authentication
* Servlet container authentication
+### GitHub OAuth
+*SINCE 1.7.0
+
+OAuth2 is a protocol that lets external apps request authorization to private
+details in a user’s GitHub account without getting their password. This is
+preferred over Basic Authentication because tokens can be limited to specific
+types of data, and can be revoked by users at any time.
++
+Site owners have to register their application before getting started. For
+more information see
+https://github.com/settings/applications/new[github-register-application].
+A registered OAuth application is assigned a unique `Client ID` and `Client
+Secret`. The `Client Secret` should never be shared.
+
+[[github.url]]github.url::
+
+GitHub URL.
+
+Default is `https://github.com`.
+
+[[github.apiUrl]]github.apiUrl::
+
+GitHub API URL.
+
+Default is `https://api.github.com`.
+
+[[github.clientId]]github.clientId::
+
+The `Client ID`, that was received from GitHub when the application was
+registered. Required.
+
+[[github.clientSecret]]github.clientSecret::
+
+The `Client Secret`, that was received from GitHub when the application was
+registered. Required.
+
+
### LDAP Authentication
*SINCE 1.0.0*
|