1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
GitHub
======
Github works similar to Facebook (OAuth).
- Register a new application at `GitHub Developers`_, set the callback URL to
``http://example.com/complete/github/`` replacing ``example.com`` with your
domain.
- Fill ``App Id`` and ``App Secret`` values in the settings::
SOCIAL_AUTH_GITHUB_KEY = ''
SOCIAL_AUTH_GITHUB_SECRET = ''
- Also it's possible to define extra permissions with::
SOCIAL_AUTH_GITHUB_SCOPE = [...]
Github for Organizations
------------------------
When defining authentication for organizations, use the
``GithubOrganizationOAuth2`` backend instead. The settings are the same than
the non-organization backend, but the names must be::
SOCIAL_AUTH_GITHUB_ORG_*
Be sure to define the organization name using the setting::
SOCIAL_AUTH_GITHUB_ORG_NAME = ''
This name will be used to check that the user really belongs to the given
organization and discard it in case he's not part of it.
Github for Teams
----------------
Similar to ``Github for Organizations``, there's a Github for Teams backend,
use the backend ``GithubTeamOAuth2``. The settings are the same than
the basic backend, but the names must be::
SOCIAL_AUTH_GITHUB_TEAM_*
Be sure to define the ``Team Id`` using the setting::
SOCIAL_AUTH_GITHUB_TEAM_ID = ''
This ``id`` will be used to check that the user really belongs to the given
team and discard it in case he's not part of it.
.. _GitHub Developers: https://github.com/settings/applications/new
|
