Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

fix: reformat yaml and clarify testing in self-hosted oauth how-to

Andrey A.2fcf513ab639
diff --git a/apps/docs/content/guides/self-hosting/self-hosted-oauth.mdx b/apps/docs/content/guides/self-hosting/self-hosted-oauth.mdx
index 702cdd87565..4297d06127c 100644
--- a/apps/docs/content/guides/self-hosting/self-hosted-oauth.mdx
+++ b/apps/docs/content/guides/self-hosting/self-hosted-oauth.mdx
@@ -70,11 +70,14 @@ GOOGLE_SECRET=your-client-secret
Uncomment the corresponding `GOTRUE_EXTERNAL_` lines in the `auth` service's `environment`:
-```
-GOTRUE_EXTERNAL_GOOGLE_ENABLED: ${GOOGLE_ENABLED}
-GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
-GOTRUE_EXTERNAL_GOOGLE_SECRET: ${GOOGLE_SECRET}
-GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_EXTERNAL_GOOGLE_ENABLED: ${GOOGLE_ENABLED}
+ GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
+ GOTRUE_EXTERNAL_GOOGLE_SECRET: ${GOOGLE_SECRET}
+ GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
```
<Admonition type="note">
@@ -94,7 +97,7 @@ docker compose up -d --force-recreate --no-deps auth
Check that the provider is enabled:
```sh
-curl https://<your-domain>/auth/v1/settings
+curl -H 'apikey: your-anon-key' https://<your-domain>/auth/v1/settings
```
The response should include your provider under `external`:
@@ -141,11 +144,14 @@ GOOGLE_SECRET=your-google-client-secret
**`docker-compose.yml`:**
-```
-GOTRUE_EXTERNAL_GOOGLE_ENABLED: ${GOOGLE_ENABLED}
-GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
-GOTRUE_EXTERNAL_GOOGLE_SECRET: ${GOOGLE_SECRET}
-GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_EXTERNAL_GOOGLE_ENABLED: ${GOOGLE_ENABLED}
+ GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID: ${GOOGLE_CLIENT_ID}
+ GOTRUE_EXTERNAL_GOOGLE_SECRET: ${GOOGLE_SECRET}
+ GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
```
</TabPanel>
@@ -171,11 +177,14 @@ GITHUB_SECRET=your-github-client-secret
**`docker-compose.yml`:**
-```
-GOTRUE_EXTERNAL_GITHUB_ENABLED: ${GITHUB_ENABLED}
-GOTRUE_EXTERNAL_GITHUB_CLIENT_ID: ${GITHUB_CLIENT_ID}
-GOTRUE_EXTERNAL_GITHUB_SECRET: ${GITHUB_SECRET}
-GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_EXTERNAL_GITHUB_ENABLED: ${GITHUB_ENABLED}
+ GOTRUE_EXTERNAL_GITHUB_CLIENT_ID: ${GITHUB_CLIENT_ID}
+ GOTRUE_EXTERNAL_GITHUB_SECRET: ${GITHUB_SECRET}
+ GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
```
</TabPanel>
@@ -207,13 +216,16 @@ AZURE_SECRET=your-azure-client-secret
**`docker-compose.yml`:**
-```
-GOTRUE_EXTERNAL_AZURE_ENABLED: ${AZURE_ENABLED}
-GOTRUE_EXTERNAL_AZURE_CLIENT_ID: ${AZURE_CLIENT_ID}
-GOTRUE_EXTERNAL_AZURE_SECRET: ${AZURE_SECRET}
-GOTRUE_EXTERNAL_AZURE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
-## Optional: uncomment for tenant-specific Azure login
-# GOTRUE_EXTERNAL_AZURE_URL: ${AZURE_URL}
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_EXTERNAL_AZURE_ENABLED: ${AZURE_ENABLED}
+ GOTRUE_EXTERNAL_AZURE_CLIENT_ID: ${AZURE_CLIENT_ID}
+ GOTRUE_EXTERNAL_AZURE_SECRET: ${AZURE_SECRET}
+ GOTRUE_EXTERNAL_AZURE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
+ ## Optional: uncomment for tenant-specific Azure login
+ # GOTRUE_EXTERNAL_AZURE_URL: ${AZURE_URL}
```
</TabPanel>
@@ -236,11 +248,14 @@ APPLE_SECRET=your-generated-jwt-client-secret
**`docker-compose.yml`:**
-```
-GOTRUE_EXTERNAL_APPLE_ENABLED: ${APPLE_ENABLED}
-GOTRUE_EXTERNAL_APPLE_CLIENT_ID: ${APPLE_CLIENT_ID}
-GOTRUE_EXTERNAL_APPLE_SECRET: ${APPLE_SECRET}
-GOTRUE_EXTERNAL_APPLE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_EXTERNAL_APPLE_ENABLED: ${APPLE_ENABLED}
+ GOTRUE_EXTERNAL_APPLE_CLIENT_ID: ${APPLE_CLIENT_ID}
+ GOTRUE_EXTERNAL_APPLE_SECRET: ${APPLE_SECRET}
+ GOTRUE_EXTERNAL_APPLE_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
```
<Admonition type="note">
@@ -276,12 +291,15 @@ KEYCLOAK_URL=https://keycloak.example.com/realms/myrealm
**`docker-compose.yml` passthrough:**
-```
-GOTRUE_EXTERNAL_KEYCLOAK_ENABLED: ${KEYCLOAK_ENABLED}
-GOTRUE_EXTERNAL_KEYCLOAK_CLIENT_ID: ${KEYCLOAK_CLIENT_ID}
-GOTRUE_EXTERNAL_KEYCLOAK_SECRET: ${KEYCLOAK_SECRET}
-GOTRUE_EXTERNAL_KEYCLOAK_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
-GOTRUE_EXTERNAL_KEYCLOAK_URL: ${KEYCLOAK_URL}
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_EXTERNAL_KEYCLOAK_ENABLED: ${KEYCLOAK_ENABLED}
+ GOTRUE_EXTERNAL_KEYCLOAK_CLIENT_ID: ${KEYCLOAK_CLIENT_ID}
+ GOTRUE_EXTERNAL_KEYCLOAK_SECRET: ${KEYCLOAK_SECRET}
+ GOTRUE_EXTERNAL_KEYCLOAK_REDIRECT_URI: ${API_EXTERNAL_URL}/auth/v1/callback
+ GOTRUE_EXTERNAL_KEYCLOAK_URL: ${KEYCLOAK_URL}
```
<Admonition type="danger">
@@ -331,7 +349,12 @@ For each provider, you need at minimum `ENABLED`, `CLIENT_ID`, `SECRET`, and `RE
## Test the login flow
-You can test OAuth with the following minimal `index.html` served, e.g., via `python -m http.server 3000`:
+You can test OAuth with the following minimal HTML page:
+
+- Save the code below to `index.html`
+- Start `python -m http.server 3000` in the same directory
+- Make sure `SITE_URL` is set to `http://localhost:3000` in your self-hosted Supabase `.env` configuration
+- Open your browser and go to `http://localhost:3000`
```html
<!doctype html>
@@ -373,12 +396,6 @@ You can test OAuth with the following minimal `index.html` served, e.g., via `py
</html>
```
-<Admonition type="tip">
-
-Make sure `SITE_URL` or `ADDITIONAL_REDIRECT_URLS` includes the URL where you open this test page. Otherwise the Auth service will reject the redirect after login.
-
-</Admonition>
-
For detailed client-side integration, see [Social Login](/docs/guides/auth/social-login).
## Troubleshooting
diff --git a/apps/docs/content/guides/self-hosting/self-hosted-phone-mfa.mdx b/apps/docs/content/guides/self-hosting/self-hosted-phone-mfa.mdx
index 64d2d13ba74..30d427e471f 100644
--- a/apps/docs/content/guides/self-hosting/self-hosted-phone-mfa.mdx
+++ b/apps/docs/content/guides/self-hosting/self-hosted-phone-mfa.mdx
@@ -42,15 +42,18 @@ SMS_TWILIO_MESSAGE_SERVICE_SID=your-message-service-sid
Uncomment the `GOTRUE_SMS_*` lines in the `auth` service's `environment` block:
-```
-GOTRUE_SMS_PROVIDER: ${SMS_PROVIDER}
-GOTRUE_SMS_OTP_EXP: ${SMS_OTP_EXP}
-GOTRUE_SMS_OTP_LENGTH: ${SMS_OTP_LENGTH}
-GOTRUE_SMS_MAX_FREQUENCY: ${SMS_MAX_FREQUENCY}
-GOTRUE_SMS_TEMPLATE: ${SMS_TEMPLATE}
-GOTRUE_SMS_TWILIO_ACCOUNT_SID: ${SMS_TWILIO_ACCOUNT_SID}
-GOTRUE_SMS_TWILIO_AUTH_TOKEN: ${SMS_TWILIO_AUTH_TOKEN}
-GOTRUE_SMS_TWILIO_MESSAGE_SERVICE_SID: ${SMS_TWILIO_MESSAGE_SERVICE_SID}
+```yaml
+auth:
+ environment:
+ # ... existing variables ...
+ GOTRUE_SMS_PROVIDER: ${SMS_PROVIDER}
+ GOTRUE_SMS_OTP_EXP: ${SMS_OTP_EXP}
+ GOTRUE_SMS_OTP_LENGTH: ${SMS_OTP_LENGTH}
+ GOTRUE_SMS_MAX_FREQUENCY: ${SMS_MAX_FREQUENCY}
+ GOTRUE_SMS_TEMPLATE: ${SMS_TEMPLATE}
+ GOTRUE_SMS_TWILIO_ACCOUNT_SID: ${SMS_TWILIO_ACCOUNT_SID}
+ GOTRUE_SMS_TWILIO_AUTH_TOKEN: ${SMS_TWILIO_AUTH_TOKEN}
+ GOTRUE_SMS_TWILIO_MESSAGE_SERVICE_SID: ${SMS_TWILIO_MESSAGE_SERVICE_SID}
```
### Step 3: Restart the auth service