Back to Tooljet

GitHub

docs/versioned_docs/version-1.x.x/user-authentication/sso/github.md

3.20.154-lts2.2 KB
Original Source

GitHub Single Sign-on

Select Manage SSO from workspace options

<div style={{textAlign: 'center'}}>

</div>

Select GitHub, GitHub login will be disabled by default

<div style={{textAlign: 'center'}}>

</div>

Enable GitHub. You can see Redirect URL generated

<div style={{textAlign: 'center'}}>

</div>

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.

<div style={{textAlign: 'center'}}>

</div>
  • Open the application details, and you can see the Client ID
<div style={{textAlign: 'center'}}>

</div>
  • Then create Client secrets by clicking Generate new client secret
<div style={{textAlign: 'center'}}>

</div>

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.

variabledescription
SSO_GIT_OAUTH2_CLIENT_IDGitHub OAuth client id
SSO_GIT_OAUTH2_CLIENT_SECRETGitHub OAuth client secret
SSO_GIT_OAUTH2_HOSTGitHub OAuth host name if GitHub is self hosted

Redirect URL should be <host>/sso/git