docs: simplify Apple wording and add 'always copy from dashboard' across all providers

Co-Authored-By: Konstantin Wohlwend <n2d4xc@gmail.com>
This commit is contained in:
Devin AI 2026-05-28 20:21:52 +00:00
parent 1d6cd74d28
commit 7a1115116a
12 changed files with 13 additions and 13 deletions

View File

@ -30,7 +30,7 @@ This guide explains how to set up Apple as an authentication provider with Hexcl
13. Enable **Sign in with Apple** by checking the box.
14. Click **Configure** next to Sign in with Apple.
15. Register your domains (for Hexclave Cloud, add `api.hexclave.com`; for self-hosted, add your API domain).
16. Add the return URL shown as the Redirect URL in the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/apple`)
16. Add the Redirect URL shown in the Hexclave dashboard when configuring Apple (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/apple` — always copy the exact value from your dashboard)
17. Click **Done**, then **Continue**, and then **Save**.
</Step>

View File

@ -16,7 +16,7 @@ This guide explains how to set up Bitbucket as an authentication provider with H
5. Fill out the form with the following details:
- **Name**: Choose a name for your application
- **Description**: Add a brief description of your application
- **Callback URL**: Enter the Redirect URL shown in the Hexclave dashboard when configuring Bitbucket (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket`)
- **Callback URL**: Enter the Redirect URL shown in the Hexclave dashboard when configuring Bitbucket (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/bitbucket` — always copy the exact value from your dashboard)
- **Permissions**: Under **Account**, select at minimum **Email** and **Read**
6. Click **Save**.
7. You'll be redirected to the OAuth consumers page. Select your newly created consumer to view its details.

View File

@ -13,7 +13,7 @@ This guide explains how to set up Discord as an authentication provider with Hex
2. Click the **New Application** button in the top-right corner.
3. Enter a name for your application and click **Create**. You will be redirected to the General Information page.
4. Select **OAuth2** in the left sidebar.
5. Under **Redirects** add the Redirect URL shown in the Hexclave dashboard when configuring Discord (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/discord`)
5. Under **Redirects** add the Redirect URL shown in the Hexclave dashboard when configuring Discord (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/discord` — always copy the exact value from your dashboard)
6. In the **OAuth2** section, enable the required scopes: 'identify' and 'email'
7. Click **Save Changes**
8. Save the **Client ID** and **Client Secret**. You may need to select **Reset Secret** to generate a new one.

View File

@ -20,7 +20,7 @@ This guide explains how to set up Facebook as an authentication provider with He
9. Next to **Authenticate and request data from users with Facebook Login**, select **Customize**.
10. On the Permissions tab, next to **email**, select **Add** to allow Hexclave to read your user's primary email address.
11. In the left sidenav, under **Facebook Login**, select **Settings**.
12. In the **Client OAuth settings** section, in the **Valid OAuth Redirect URIs** field, add the Redirect URL shown in the Hexclave dashboard when configuring Facebook (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/facebook`)
12. In the **Client OAuth settings** section, in the **Valid OAuth Redirect URIs** field, add the Redirect URL shown in the Hexclave dashboard when configuring Facebook (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/facebook` — always copy the exact value from your dashboard)
13. Select **Save changes**.
14. In the left sidenav, select **App settings** (hover over the settings icon), and then select **Basic**.
15. Note your **App ID** and **App Secret** for the next steps.

View File

@ -24,7 +24,7 @@ This guide explains how to set up GitHub as an authentication provider with Hexc
1. Navigate to your [GitHub Developer App Settings](https://github.com/settings/apps).
2. Click the **New GitHub App** button.
3. Enter a name for your application, homepage URL, and a description.
4. For **Authorization callback URL**, add the Redirect URL shown in the Hexclave dashboard when configuring GitHub (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/github`)
4. For **Authorization callback URL**, add the Redirect URL shown in the Hexclave dashboard when configuring GitHub (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/github` — always copy the exact value from your dashboard)
5. For permissions, at a **minimum**, you will need **Account Permissions > Email Addresses** set to **Read Only**. Your sign-in flow will not work without this permission.
6. Select **Any Account** under the ***Where can this GitHub App be installed*** section.
7. Click **Create GitHub App**
@ -50,7 +50,7 @@ This guide explains how to set up GitHub as an authentication provider with Hexc
1. Navigate to your [GitHub Developer Settings](https://github.com/settings/developers).
2. Click the **New OAuth App** button.
3. Enter a name for your application, homepage URL, and a description.
4. For **Authorization callback URL**, add the Redirect URL shown in the Hexclave dashboard when configuring GitHub (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/github`)
4. For **Authorization callback URL**, add the Redirect URL shown in the Hexclave dashboard when configuring GitHub (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/github` — always copy the exact value from your dashboard)
5. Click **Register application**
6. Save the **Client ID** and click **Generate a new client secret** to create your **Client Secret**.
</Step>

View File

@ -14,7 +14,7 @@ This guide explains how to set up GitLab as an authentication provider with Hexc
3. In the left sidebar, select **Applications** > **Add new application**.
4. Fill out the form with the following details:
- **Name**: Choose a name for your application
- **Redirect URI**: Enter the Redirect URL shown in the Hexclave dashboard when configuring GitLab (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/gitlab`)
- **Redirect URI**: Enter the Redirect URL shown in the Hexclave dashboard when configuring GitLab (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/gitlab` — always copy the exact value from your dashboard)
- **Scopes**: Select at minimum the `profile` and `email` scopes
5. Click **Save application**.
6. GitLab will display your **Application ID** and **Secret**. Make note of these values as you'll need them for the next steps.

View File

@ -22,7 +22,7 @@ This guide explains how to set up Google as an authentication provider with Hexc
4. Click **Create Credentials** and select **OAuth client ID**.
5. Select **Web application** as the application type.
6. Enter a name for your OAuth client.
7. Under **Authorized redirect URIs**, add the Redirect URL shown in the Hexclave dashboard when configuring Google (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/google`)
7. Under **Authorized redirect URIs**, add the Redirect URL shown in the Hexclave dashboard when configuring Google (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/google` — always copy the exact value from your dashboard)
8. Click **Create**.
9. Save the **Client ID** and **Client Secret** that are displayed.
</Step>

View File

@ -16,7 +16,7 @@ This guide explains how to set up LinkedIn as an authentication provider with He
5. Enter the **App description** and your **Business email**.
6. Check the **Legal agreement** box and click **Create app**.
7. On your app's dashboard, click **Auth** tab from the left sidebar.
8. Under **OAuth 2.0 settings**, add the Redirect URL shown in the Hexclave dashboard when configuring LinkedIn (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/linkedin`)
8. Under **OAuth 2.0 settings**, add the Redirect URL shown in the Hexclave dashboard when configuring LinkedIn (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/linkedin` — always copy the exact value from your dashboard)
9. Under **Products**, request access to **Sign In with LinkedIn** by clicking **Request access**. Complete any required information.
10. Under **OAuth 2.0 scopes**, make sure at least the following scopes are selected:
- `r_emailaddress`

View File

@ -19,7 +19,7 @@ This guide explains how to set up Microsoft as an authentication provider with H
3. Click **New registration** at the top of the page.
4. Enter a name for your application.
5. Under **Supported account types**, select the option that best suits your needs (typically **Accounts in any organizational directory and personal Microsoft accounts**).
6. In the **Redirect URI** section, select **Web** as the platform and enter the Redirect URL shown in the Hexclave dashboard when configuring Microsoft (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/microsoft`)
6. In the **Redirect URI** section, select **Web** as the platform and enter the Redirect URL shown in the Hexclave dashboard when configuring Microsoft (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/microsoft` — always copy the exact value from your dashboard)
7. Click **Register** to create the application.
8. You'll be redirected to the app's Overview page. Note the **Application (client) ID** displayed at the top.
9. In the left sidebar, click **Certificates & secrets**.

View File

@ -18,7 +18,7 @@ This guide explains how to set up Spotify as an authentication provider with Hex
2. Log in with your Spotify account.
3. Click **Create app** to create a new application.
4. Enter an **App name** and **App description**.
5. Under **Redirect URI**, add the Redirect URL shown in the Hexclave dashboard when configuring Spotify (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/spotify`)
5. Under **Redirect URI**, add the Redirect URL shown in the Hexclave dashboard when configuring Spotify (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/spotify` — always copy the exact value from your dashboard)
6. Check the agreement checkbox and click **Create**.
7. You'll be redirected to your app's dashboard. Note your **Client ID** displayed on this page.
8. Click **Settings** to view more details about your app.

View File

@ -13,7 +13,7 @@ This guide explains how to set up Twitch as an authentication provider with Hexc
2. Log in with your Twitch account.
3. Navigate to **Applications** and click **Register New Application**.
4. Enter a **Name** and select a **Category**.
5. Under **OAuth Redirect URLs**, add the Redirect URL shown in the Hexclave dashboard when configuring Twitch (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/twitch`)
5. Under **OAuth Redirect URLs**, add the Redirect URL shown in the Hexclave dashboard when configuring Twitch (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/twitch` — always copy the exact value from your dashboard)
6. Click **Create**.
7. You'll be redirected to your app's dashboard.
8. Click **Manage** of the app you just created to view more details about your app.

View File

@ -21,7 +21,7 @@ This guide explains how to set up X (formerly Twitter) as an authentication prov
10. Click **Set up** or **Edit** if already configured.
11. Enable **OAuth 2.0** and set the following details:
- **Type of App**: Web App
- **Callback URL / Redirect URL**: the Redirect URL shown in the Hexclave dashboard when configuring X (for Hexclave Cloud, this is `https://api.hexclave.com/api/v1/auth/oauth/callback/x`)
- **Callback URL / Redirect URL**: the Redirect URL shown in the Hexclave dashboard when configuring X (for Hexclave Cloud, this is commonly `https://api.hexclave.com/api/v1/auth/oauth/callback/x` — always copy the exact value from your dashboard)
- **Website URL**: Your website's URL
12. Under **App permissions**, select your scopes.
13. Click **Save** to apply your changes.