mirror of https://github.com/status-im/cabot.git
Merge pull request #504 from nickromano/github-sso-gh-pages
Documentation for Github SSO
This commit is contained in:
commit
c00fa9d62b
|
@ -34,3 +34,54 @@ Click the <i class="icon-edit"></i> edit icon next to a user to configure:
|
|||
* e.g. `david`
|
||||
* `Fallback alert user` - this is the user who will receive telephone and other alerts if nobody else is [marked in the rota](rota.html) as being on duty.
|
||||
|
||||
### Github SSO
|
||||
|
||||
Administer users by whitelisting your Github organization.
|
||||
|
||||
#### Github Configuration
|
||||
|
||||
For Github Enterprise see below.
|
||||
|
||||
1) Head to https://github.com/organizations/**yourorganzation**/settings/applications/new and create a new OAuth application. Enter the following into the form and replace http://localhost:5001 with your hostname.
|
||||
|
||||
![Create OAuth application](/images/github-org-application.png)
|
||||
|
||||
* Application Name: Cabot
|
||||
* Homepage URL: http://localhost:5001/
|
||||
* Authorization Callback URL: http://localhost:5001/complete/github-org/
|
||||
|
||||
2) Take the client id and client secret and add them to the following environment variables:
|
||||
|
||||
```
|
||||
LOGIN_URL=/login/github-org/
|
||||
AUTH_GITHUB_ORG=True
|
||||
AUTH_GITHUB_ORG_CLIENT_ID=2l34k5j43tb46l2kj234
|
||||
AUTH_GITHUB_ORG_CLIENT_SECRET=23l4k5j43l6k546lk5n4kl64j2j3l5k4jjlkj2345
|
||||
AUTH_GITHUB_ORG_NAME=myorganization
|
||||
```
|
||||
|
||||
3) Visit `http://localhost:5001/login/github-org/` and you should be redirected to the Github authorization flow.
|
||||
|
||||
#### Github Enterprise Configuration
|
||||
|
||||
1) Head to https://**mygithubenterprise.com**/organizations/**yourorganzation**/settings/applications/new and create a new OAuth application. Enter the following into the form and replace http://localhost:5001 with your hostname.
|
||||
|
||||
![Create OAuth application](/images/github-enterprise-org-application.png)
|
||||
|
||||
* Application Name: Cabot
|
||||
* Homepage URL: http://localhost:5001/
|
||||
* Authorization Callback URL: http://localhost:5001/complete/github-enterprise-org/
|
||||
|
||||
2) Take the client id and client secret and add them to the following environment variables:
|
||||
|
||||
```
|
||||
LOGIN_URL=/login/github-enterprise-org/
|
||||
GITHUB_ENTERPRISE_ORG_AUTH=True
|
||||
GITHUB_ENTERPRISE_ORG_URL=https://mygithubenterprise.com/
|
||||
GITHUB_ENTERPRISE_ORG_API_URL=https://mygithubenterprise.com/api/v3/
|
||||
GITHUB_ENTERPRISE_ORG_KEY=alskdjflkj5lk123j345l3
|
||||
GITHUB_ENTERPRISE_ORG_SECRET=alskjdflkasjdflqkj5lkntrk13j45lk3451453245
|
||||
GITHUB_ENTERPRISE_ORG_NAME=myorganization
|
||||
```
|
||||
|
||||
3) Visit `http://localhost:5001/login/github-enterprise-org/` and you should be redirected to the Github authorization flow.
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 210 KiB |
Binary file not shown.
After Width: | Height: | Size: 249 KiB |
Loading…
Reference in New Issue