GitHub OAuth | Appsmith - SolFind Web Lens

GitHub OAuth | Appsmith

https://docs.appsmith.com/getting-started/setup/instance-configuration/authentication/github-login • 50 KB fetched
Open original page

GitHub OAuth | Appsmith

Ask AI
Search

Ask Appsmith AI Submit message

Examples How do I install Appsmith using Docker? How do I connect to my local PostgreSQL database? How do I pass inputs from a widget to a query? How do I trigger multiple queries conditionally? How do I fix the error: This value does not evaluate to type Array<Object>?

Try Appsmith

* Get Started

* Introduction

* Build Your First App

* Self Hosting

* New Installation Guides

* Manage Installation

* High Availability Guides

* Authentication Guides

* Google OAuth

* GitHub OAuth

* SAML SSO

* OpenID Connect SSO

* Helm Chart

* Custom Domain and SSL Guides

* Email Setup Guides

* Backup and Restore Guides

* Other Configuration Guides

* Reference

* Upgrade Installation Guides

* Concepts

* Connect Data

* Overview

* How-to Guides

* Reference

* Datasources

* Query Settings

* Concepts

* Build Apps

* Overview

* Quickstart

* How-to Guides

* Reference

* Widgets

* Accessibility

* Theme

* Sample Apps

* Write Code

* Overview

* How-to Guides

* Reference

* Global Objects

* Global Functions

* JS Libraries

* Fetch API

* Data Transformation

* JavaScript Settings

* Concepts

* Best Practices

* Manage Apps and Users

* Authentication

* Granular Access Control

* Versioning with Git

* Setup SCIM Provisioning

* Embed Appsmith

* Migrate Applications

* Audit Logs

* Branding

* External Client Portal

* Packages

* Overview

* Tutorial

* How-to Guides

* Reference

* Package Version Control

* GIT Apps with Packages Best Practices

* Code Packages

* UI Packages

* Workflows

* Overview

* Tutorial

* How-to Guides

* Reference

* Workflow Triggers

* Workflow Queries

* Workflow Functions

* Pass Parameters to Workflows

* Run History

* Troubleshooting

* Overview

* Self-hosting Errors

* Application Errors

* Product

* FAQ

* Security

* Telemetry

* Support at Appsmith

* Privacy Policy

* Release Notes

* Contribute

* Self Hosting

* Manage Installation

* Authentication Guides

* GitHub OAuth
On this page
GitHub OAuth

This page shows how to configure Appsmith to use GitHub OAuth as an authentication provider. By integrating with GitHub OAuth, Appsmith enables end users to sign in to their Appsmith accounts using their GitHub credentials.

Prerequisites

* A self-hosted Appsmith instance. See the installation guides for installing Appsmith.

* A GitHub account.

* Before setting up GitHub OAuth, ensure that you have already configured a custom domain for your instance.

* In Appsmith, go to Admin Settings > Authentication and click Enable on GitHub .

Create OAuth App on GitHub

*
Open your GitHub Account .

*
Navigate to your profile icon in the top-right corner and open Settings .

*
In Settings , go to Developer Settings > OAuth Apps and click New OAuth apps to configure a new Appsmith OAuth app.

* Add the following details for the OAuth app configuration:

*
Application Name: Enter a name for your application (e.g., Appsmith GitHub OAuth ).

*
Homepage URL: Copy and paste the Homepage URL from the GitHub configuration in Appsmith (e.g., https://app.appsmith.com ).

*
Authorization Callback URL: Copy and paste the Callback URL from the GitHub configuration in Appsmith (e.g., https://app.appsmith.com/login/oauth2/code/github ) and paste it here.

* Click Register application to create the OAuth app. Once the app is created, copy the Client ID and Client Secret to use in Appsmith’s GitHub configuration.

To complete the Github OAuth configuration, you have to register the provider on Appsmith. Go to Admin Settings > Authentication > Github , and follow the steps below:

*
Add the Client ID and Client Secret copied from the Github OAuth Settings into the respective fields.

*
Once you have added the details, click the Save & Restart button to save the configuration and restart the instance.

info
If you're running Appsmith on a Kubernetes cluster with an HA configuration, after completing the setup, run the following command to ensure the new authentication settings are properly applied:
kubectl rollout restart deployment / appsmith - n

After the Appsmith instance restarts, log in to your account to see the GitHub Login button on the login screen.

GitHub OAuth | Appsmith

Links found on this page