Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-22 22:17:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
ToolJet/docs/versioned_docs/version-2.2.0/user-authentication/sso/github.md
Shubhendra Singh Chauhan 02e218c24c
[doc] version 2.2.0 (#5755) 
* doc version 2.2.0

* updated v2.0 v2.1 v2.2 docs for ses dynamo and s3
2023-03-16 12:58:33 +05:30

2.6 KiB
Raw Blame History

id title
github GitHub

GitHub Single Sign-on

  • Go to the Workspace Settings (⚙️) from the left sidebar in the ToolJet dashboard

    General Settings: SSO

  • Select SSO from sidebar and then select GitHub. GitHub login will be disabled by default,

    General Settings: SSO

  • Enable GitHub. You can see Redirect URL generated

    General Settings: SSO

  • Go to GitHub Developer settings and navigate to OAuth Apps and create a project. Authorization callback URL should be the generated Redirect URL in Git manage SSO page.

    General Settings: SSO

  • Open the application details, and you can see the Client ID

    General Settings: SSO

  • Then create Client secrets by clicking Generate new client secret

    General Settings: SSO

Lastly, enter Client Id and Client Secret in GitHub manage SSO page and save.

The GitHub sign-in button will now be available in your ToolJet login screen if you have not enabled Multi-Workspace.

:::info Should configure Host Name if you are using GitHub Enterprise self hosted. Host name should be a URL and should not ends with /, example: https://github.tooljet.com :::

Multi-Workspace

If you have enabled Multi-Workspace you can configure GitHub SSO as mentioned above, for setting default SSO for the instance use environment variable.

variable description
SSO_GIT_OAUTH2_CLIENT_ID GitHub OAuth client id
SSO_GIT_OAUTH2_CLIENT_SECRET GitHub OAuth client secret
SSO_GIT_OAUTH2_HOST GitHub OAuth host name if GitHub is self hosted

Redirect URL should be <host>/sso/git