trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/docs/integrations/sources/github/index.md
Ernie 2a670afd02
Break down Sources into individual sections in Docs (#1052) 
* Create index.mdx

Add Wekan example

* updated to include wekan entry

* Update and rename website/docs/sources.md to website/docs/sources/index.md

Break Sources into individual pages.

* Update and rename website/docs/sources/index.md to website/docs/sources/ldap/index.md

* Create index.md

* Update index.md

* Update index.md

* Create index.md

* Create index.md

* Create index.md

* Update index.md

* Update index.md

* Update index.md

* Create index.md

* discord images

* spacing

* Added discord

* discord changes

* Added sources breakdown to the sidebar

* Fixed the saml title

* Added github examples

* fixed formatting

* Changed file path, updated sidebar, added google.

* fixed a spelling mistake

* Cleaned up formatting

* Fixed Notes
2021-06-22 21:46:44 +02:00

1.9 KiB
Raw Blame History

title
Github

Allows users to authenticate using their Github credentials

Preparation

The following placeholders will be used:

  • authentik.company is the FQDN of the authentik install.
  • www.my.company Homepage URL for your site

Github

  1. Create an OAuth app under Developer Settings https://github.com/settings/developers by clicking on the Register a neww application

Register OAuth App

  1. Application Name: Choose a name users will recognize ie: Authentik
  2. Homepage URL:: www.my.company
  3. Authorization callback URL: https://authentik.company/source/oauth/callback/github
  4. Click Register Application

Example screenshot

Example Screen

  1. Copy the Client ID and save it for later
  2. Click Generate a new client secret and save it for later You will not be able to see the secret again, so be sure to copy it now.

Authentik

  1. Under Resources -> Sources Click Create Github OAuth Source

  2. Name: Choose a name (For the example I use Github)

  3. Slug: github (If you choose a different slug the URLs will need to be updated to reflect the change)

  4. Consumer Key: Client ID from step 6

  5. Consumer Secret: Client Secret from step 7

  6. Provider Type: Github

Expand URL settings:

:::note As of June 20 2021 these URLS are correct. Here is the Github reference URL https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps :::

  1. Authorization URL: https://github.com/login/oauth/authorize
  2. Access token URL: https://github.com/login/oauth/access_token
  3. Profile URL: https://api.github.com/user

Here is an exmple of a complete Authentik Github OAuth Source

Example Screen

Save, and you now have Github as a source.

:::note For more details on how-to have the new source display on the Login Page see the Sources page :::