This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Oauth provider guides #383

Draft

gewenyu99 wants to merge 9 commits into main from oauth-providers

Contributor

gewenyu99 commented Jun 8, 2023

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)


          Init github oauth provider guide

d9d5f69

gewenyu99 commented

View reviewed changes

app/views/docs/oauth-providers/github.md

+              account.createOAuth2Session('github', '[LINK_ON_SUCCESS]', '[LINK_ON_FAILURE]');
+              ```
+              ### Flutter

Contributor Author

gewenyu99 Jun 8, 2023

gewenyu99 commented

View reviewed changes

app/views/docs/oauth-providers/github.md

+              });
+              ```
+              ### Flutter

Contributor Author

gewenyu99 Jun 8, 2023

lohanidamodar and others added 8 commits

June 11, 2023 06:06


          Update github.md

6c06d64


          Update github.md

1680f43


          Update github.md

eb5a98e


          complete the example GitHub guide

cc3f9be


          refreshing OAuth2 session dart code fix

dd9c0f0


          added comments back

8f28820


          type error

8e43d65


          Merge pull request #395 from asutoshranjan/dart-code-fix

f3d82bd

Dart code fix in refreshing OAuth2 session

stnguyen90 mentioned this pull request

Create GH workflow to generate github metrics appwrite/.github#23

Merged

This was referenced Jul 25, 2023

PRs Opened in June 2023 appwrite/.github#37

Closed

PRs Opened in June 2023 appwrite/.github#43

Closed

PRs Opened in June 2023 appwrite/.github#49

Closed

PRs Opened in June 2023 appwrite/.github#54

Closed

stnguyen90 suggested changes

View reviewed changes

app/views/docs/oauth-providers/github.md

+              Don't close this modal, we'll need to create a GitHub OAuth app to complete this form.
+              ## Creating a GitHub OAuth app
+              To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console.

Contributor

stnguyen90 Aug 2, 2023 •

edited

Loading

Suggested change

      
            To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console.
          
            To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your GitHub organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide an **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console.

stnguyen90 suggested changes

View reviewed changes

app/views/docs/oauth-providers/github.md

+. Navigate to your Appwrite project
+. Navigate to **Auth** > **Settings**
+. Find and open the OAuth provider
+. In the **Github OAuth2 Settings** modal, use the toggle to enable the provider

Contributor

stnguyen90 Aug 2, 2023

Suggested change

      
            4. In the **Github OAuth2 Settings** modal, use the toggle to enable the provider
          
            4. In the **GitHub OAuth2 Settings** modal, use the toggle to enable the provider

This is going to be fixed in 1.4.x:

app/views/docs/oauth-providers/github.md

+              ## Creating a GitHub OAuth app
+              To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console.
+              After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal.

Contributor

stnguyen90 Aug 2, 2023

Suggested change

      
            After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal.
          
            After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **GitHub OAuth2 Settings** modal.

app/views/docs/oauth-providers/github.md

+              To use GitHub OAuth with Appwrite, you need to create an OAuth app on your GitHub account or in your Github organization. You can do this by following the [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) guide from GitHub. When prompted to provide a **Authorization callback URL**, provide the **URI** found in the **Github OAuth2 Settings** modal from your Appwrite console.
+              After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal.
+              - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console.

Contributor

stnguyen90 Aug 2, 2023

Suggested change

      
            - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console.
          
            - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **GitHub OAuth2 Settings** modal from the Appwrite console.

app/views/docs/oauth-providers/github.md

+              After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal.
+              - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console.
+              - Navigate to the **Client secrets** section in your Github OAuth app and click **Generate a new client secret**.

Contributor

stnguyen90 Aug 2, 2023

Suggested change

      
            - Navigate to the **Client secrets** section in your Github OAuth app and click **Generate a new client secret**.
          
            - Navigate to the **Client secrets** section in your GitHub OAuth app and click **Generate a new client secret**.

app/views/docs/oauth-providers/github.md

+              After you've created your GitHub OAuth app, you can head back to your Appwrite console to complete the form in the **Github OAuth2 Settings** modal.
+              - Find the **Client ID** in your GitHub OAuth app and provide this in the **App ID** field in the **Github OAuth2 Settings** modal from the Appwrite console.
+              - Navigate to the **Client secrets** section in your Github OAuth app and click **Generate a new client secret**.
+              - Copy your new client secret and provide this in the **App Secret** field in the **Github OAuth2 Settings** modal from the Appwrite console.

Contributor

stnguyen90 Aug 2, 2023

Suggested change

      
            - Copy your new client secret and provide this in the **App Secret** field in the **Github OAuth2 Settings** modal from the Appwrite console.
          
            - Copy your new client secret and provide this in the **App Secret** field in the **GitHub OAuth2 Settings** modal from the Appwrite console.

app/views/docs/oauth-providers/github.md

+              Before you can use GitHub to authenticate users, you need to enable the provider in your Appwrite console.
+. Navigate to your Appwrite project
+. Navigate to **Auth** > **Settings**
+. Find and open the OAuth provider

Contributor

stnguyen90 Aug 2, 2023

Suggested change

      
            3. Find and open the OAuth provider
          
            3. Find and open the OAuth2 provider

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet