Configure GitHub Authentication
Web3 apps can select and enable user onboarding via GitHub by configuring the Social Auth settings in the Arcana Developer Dashboard before integrating the app with the Arcana Auth SDK.
Warning
-
Some of the authentication provider configuration steps are performed using the GitHub Developer Settings Dashboard, whereas the others use the Arcana Developer Dashboard. After configuring GitHub, simply integrate the app with the Arcana Auth SDK, initialize the
AuthProvider, and only then add code in the app to trigger user authentication via GitHub. -
When utilizing global keys in the Mainnet configuration profile, developers do not need to configure the social login section in the Arcana Developer Dashboard or set up provider-specific OAuth settings to obtain a clientID. If you are using a copy of the Testnet configuration profile as the Mainnet configuration profile, remove the Social Auth section settings altogether. Simply use the Arcana assigned Client ID for integrating the app with the Arcana Auth SDK.
Step 1: Get Redirect URI
Go to the Arcana Developer Dashboard: https://dashboard.arcana.network
Register the app by creating a new entry using the 'Create New App' wizard.
Registering App
Skip this step if you have already registered your app using the Arcana Developer Dashboard and obtained a Client ID.
Go to the app configuration screen on the Arcana Developer Dashboard and click Configure > Social Auth section in the LHS. Copy the redirect URI value displayed on the top RHS. This will be used in the next step to generate GitHub OAuth credentials.
Do not close the Arcana Developer Dashboard browser tab. Open another tab and set up GitHub OAuth. Then come back to the Arcana Developer Dashboard tab and complete the app configuration settings.
Step 2: GitHub Developer Settings
Go to the GitHub Developer Settings > OAuth Apps and register the app as a new GitHub application.
- Enter the app name.
- Specify the homepage URL where the app is deployed.
- Provide a brief description of the dApp.
Use the redirect URI value that you saved in the previous step from the Auth tab of the Arcana Developer Dashboardd, in the Authorization callback URL field. See here for GitHub OAuth details.
Save the newly registered application in GitHub Developer Settings. GitHub will generate a unique ClientID and a secret for this new application entry.
Copy and save the Client ID and the secret assigned by GitHub for the newly registered app. It will be required in the next step while completing the Arcana Developer Dashboard app configuration.
Step 3: Update the Arcana Developer Dashboard
Revisit the Arcana Developer Dashboard. View the app configuration screen. Click Configure > Social Auth in the LHS navigation bar and refer to the "GitHub" field. Paste the Client ID and the Secret assigned by GitHub, in the previous step.
Save the settings. Arcana assigns a Client ID to every registered app. You need to save this Client ID and use it while integrating the app with the Arcana Auth SDK.
You are all set with the GitHub configuration. Integrate the Web3 app with the Arcana Auth SDK, onboard users and enable the authenticated users to sign blockchain transactions. See Arcana wallet Developer's Guide for details.