mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
## What kind of change does this PR introduce? Docs update. Aligns documentation and style guides with the **Sign in / Sign out / Sign up** platform standard. Closes DOCS-1328. Related to [#49874](https://github.com/supabase/supabase/pull/49874). ## What is the current behavior? Docs style guides prefer _login_ / _log in_. Guide prose uses mixed login and sign in wording. ## What is the new behavior? - [WORD_LIST.md](apps/docs/WORD_LIST.md) and [copywriting.mdx](apps/design-system/content/docs/copywriting.mdx) document the sign in standard - Design-system auth examples updated - Guide prose and API reference spec descriptions updated ### Terminology **Standard:** Use _sign in_, _sign out_, and _sign up_ as verbs. Use _sign-in_, _sign-out_, and _sign-up_ as nouns and adjectives. Match Studio UI labels (**Sign in**, **Sign out**, **Sign up**). **Preserved intentionally:** | Category | Keep as-is | Example | | -------- | ---------- | ------- | | Feature name | social login | `/social-login`, `features.mdx` heading, OAuth provider section | | URL slugs | `login` in paths | `/phone-login`, `/login-flows`, `choosing-login-flow` | | CLI | `supabase login` / `supabase logout` | Reference ids `supabase-login` / `supabase-logout`; executable commands unchanged | | SDK methods | `logout()` | Kotlin/Swift method names in API reference titles and examples | | Third-party UI | Provider product labels | Facebook Login, Kakao Login, portal **Login** buttons | | Postgres | Database terminology | login privileges, login credentials, login via role | | Audit/logging | Log prose | "Generates the following **log** in the Postgres Logs" | | Code and routes | Paths and filenames | `app/login/`, `Login.tsx`, `demos/android-login` | | External URLs | Third-party login pages | `dash.cloudflare.com/login`, `console.neon.tech/login`, `vercel.com/login` | | API identifiers | Event and field names | Audit actions `login`/`logout`, `should_logout_user` | ## To test - Run `pnpm lint:mdx` in `apps/docs` - Spot-check `features.mdx`, `social-login.mdx`, and a provider guide (e.g. Facebook, Kakao) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized authentication terminology across guides, reference material, CLI documentation, and copywriting guidance using “sign in,” “sign out,” and “sign up.” * Updated authentication instructions, headings, link text, examples, and SSO guidance for clearer, more consistent wording. * Corrected related grammar, spelling, hyphenation, and documentation links while preserving established product names and implementation commands. * **Style** * Refined code examples with consistent import ordering and spacing. * **Examples** * Updated authentication button and menu labels to “Sign in” and “Sign out.” <!-- end of auto-generated comment: release notes by coderabbit.ai -->
128 lines
6.1 KiB
Plaintext
128 lines
6.1 KiB
Plaintext
---
|
|
title: 'Postgres SSL Enforcement'
|
|
description: 'Enforce SSL usage for all Postgres connections'
|
|
---
|
|
|
|
Your Supabase project supports connecting to the Postgres DB without SSL enabled to maximize client compatibility. For increased security, you can prevent clients from connecting if they're not using SSL.
|
|
|
|
Disabling SSL enforcement only applies to connections to Postgres, Supavisor (shared Connection Pooler) and PgBouncer (dedicated Connection Pooler); all HTTP APIs offered by Supabase (e.g., PostgREST, Storage, Auth) automatically enforce SSL on all incoming connections.
|
|
|
|
<Admonition type="caution">
|
|
|
|
Applying or updating SSL enforcement triggers a fast database reboot. On small projects this usually completes in a few seconds, but larger databases may see a longer interruption.
|
|
|
|
</Admonition>
|
|
|
|
## Manage SSL enforcement via the dashboard
|
|
|
|
SSL enforcement can be configured via the "Enforce SSL on incoming connections" setting under the SSL Configuration section in [Database Settings page](/dashboard/project/_/database/settings) of the dashboard.
|
|
|
|
<Admonition type="note">
|
|
|
|
Updating SSL enforcement requires a brief database reboot. This restarts only the database and involves a few minutes of downtime.
|
|
|
|
</Admonition>
|
|
|
|
## Manage SSL enforcement via the Management API
|
|
|
|
You can also manage SSL enforcement using the Management API:
|
|
|
|
```bash
|
|
# Get your access token from https://supabase.com/dashboard/account/tokens
|
|
export SUPABASE_ACCESS_TOKEN="your-access-token"
|
|
export PROJECT_REF="your-project-ref"
|
|
|
|
# Get current SSL enforcement status
|
|
curl -X GET "https://api.supabase.com/v1/projects/$PROJECT_REF/ssl-enforcement" \
|
|
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN"
|
|
|
|
# Enable SSL enforcement
|
|
curl -X PUT "https://api.supabase.com/v1/projects/$PROJECT_REF/ssl-enforcement" \
|
|
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"requestedConfig": {
|
|
"database": true
|
|
}
|
|
}'
|
|
|
|
# Disable SSL enforcement
|
|
curl -X PUT "https://api.supabase.com/v1/projects/$PROJECT_REF/ssl-enforcement" \
|
|
-H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"requestedConfig": {
|
|
"database": false
|
|
}
|
|
}'
|
|
```
|
|
|
|
## Manage SSL enforcement via the CLI
|
|
|
|
To get started:
|
|
|
|
1. [Install](/docs/guides/local-development) the Supabase CLI 1.37.0+.
|
|
1. [Sign in](/docs/guides/local-development/database-migrations#sign-in-to-the-supabase-cli) to your Supabase account using the CLI.
|
|
1. Ensure that you have [Owner or Admin permissions](/docs/guides/platform/access-control#manage-team-members) for the project that you are enabling SSL enforcement.
|
|
|
|
### Check enforcement status
|
|
|
|
You can use the `get` subcommand of the CLI to check whether SSL is currently being enforced:
|
|
|
|
```bash
|
|
supabase ssl-enforcement get --project-ref {ref} --experimental
|
|
```
|
|
|
|
Response if SSL is being enforced:
|
|
|
|
```bash
|
|
SSL is being enforced.
|
|
```
|
|
|
|
Response if SSL is not being enforced:
|
|
|
|
```bash
|
|
SSL is *NOT* being enforced.
|
|
```
|
|
|
|
### Update enforcement
|
|
|
|
The `update` subcommand is used to change the SSL enforcement status for your project:
|
|
|
|
```bash
|
|
supabase ssl-enforcement update --project-ref {ref} --enable-db-ssl-enforcement --experimental
|
|
```
|
|
|
|
Similarly, to disable SSL enforcement:
|
|
|
|
```bash
|
|
supabase ssl-enforcement update --project-ref {ref} --disable-db-ssl-enforcement --experimental
|
|
```
|
|
|
|
### A note about Postgres SSL modes
|
|
|
|
Postgres supports [multiple SSL modes](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION) on the client side. These modes provide different levels of protection. Depending on your needs, it is important to verify that the SSL mode in use is performing the required level of enforcement and verification of SSL connections.
|
|
|
|
| SSL Mode | Encryption | Verifies CA | Verifies Hostname | Description |
|
|
| ------------- | ---------- | ----------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `disable` | No | No | No | SSL is not used. All data is transmitted in plaintext. |
|
|
| `allow` | Optional | No | No | Tries a non-SSL connection first; falls back to SSL if the server requires it. |
|
|
| `prefer` | Optional | No | No | Tries an SSL connection first; falls back to non-SSL if the server doesn't support it. This is the default. |
|
|
| `require` | Yes | No | No | Always uses SSL, but does not verify the server certificate or hostname. |
|
|
| `verify-ca` | Yes | Yes | No | Uses SSL and verifies that the server certificate is signed by a trusted CA. |
|
|
| `verify-full` | Yes | Yes | Yes | Uses SSL, verifies the CA certificate, and confirms the hostname matches the certificate. Recommended when SSL enforcement is enabled. |
|
|
|
|
The strongest mode offered by Postgres is `verify-full` and this is the mode you most likely want to use when SSL enforcement is enabled. To use `verify-full` you will need to download the Supabase CA certificate for your database. The certificate is available through the dashboard under the SSL Configuration section in the [Database Settings page](/dashboard/project/_/database/settings).
|
|
|
|
Once the CA certificate has been downloaded, add it to the certificate authority list used by Postgres.
|
|
|
|
```bash
|
|
cat {location of downloaded prod-ca-2021.crt} >> ~/.postgres/root.crt
|
|
```
|
|
|
|
With the CA certificate added to the trusted certificate authorities list, use `psql` or your client library to connect to Supabase:
|
|
|
|
```bash
|
|
psql "postgresql://aws-0-eu-central-1.pooler.supabase.com:6543/postgres?sslmode=verify-full" -U postgres.<user>
|
|
```
|