Add GitHub oauth2 configuration setup

AbandonTech · Jun 4, 2024 · f0525e8 · f0525e8
1 parent 2bcc1b8
commit f0525e8
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/docs/GITHUB-OAUTH2.md b/docs/GITHUB-OAUTH2.md
@@ -0,0 +1,22 @@
+# GitHub OAuth2 Setup
+
+###  1. Goto [GitHub Developer Apps](https://github.com/settings/developers)
+
+### 2. Create a New Application
+![GitHub Create Application](./imgs/github-create-application.png)
+
+### 3. Add details
+![GitHub Create Application Details](./imgs/github-create-application-details.png)
+
+### 4. Get Client ID and Secrets
+![GitHub Client ID And Secrets](./imgs/github-get-clientid-and-clientsecret.png)
+
+### 5. Fill `.env` file
+
+```dotenv
+# GitHub Application Details for OAuth2
+GITHUB_CLIENT_ID=<Client ID in step 4>
+GITHUB_CLIENT_SECRET=<Client Secret in step 4>
+ABANDON_AUTH_GITHUB_CALLBACK='http://localhost:8000/ui/github-callback'
+ABANDON_AUTH_GITHUB_REDIRECT="https://github.com/login/oauth/authorize?client_id=$GITHUB_CLIENT_ID&redirect_uri=$ABANDON_AUTH_GITHUB_CALLBACK&scope=user:email"
+```
diff --git a/docs/imgs/github-create-application-details.png b/docs/imgs/github-create-application-details.png
diff --git a/docs/imgs/github-create-application.png b/docs/imgs/github-create-application.png
diff --git a/docs/imgs/github-get-clientid-and-clientsecret.png b/docs/imgs/github-get-clientid-and-clientsecret.png