Skip to content

Commit

Permalink
Merge pull request supabase#15855 from supabase/ip/ssl-enforcement-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
inian authored Jul 20, 2023
2 parents 40d7440 + ce55d07 commit e442b8a
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions apps/docs/pages/guides/platform/ssl-enforcement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,27 @@ export const meta = {

<Admonition type="note">

Postgres SSL Enforcement is currently in beta and is slowly being made available to all projects. [Contact support](https://supabase.com/dashboard/support/new) if you'd like to request early access.
Postgres SSL Enforcement is currently in beta. Some projects need to [upgrade](/docs/guides/platform/migrating-and-upgrading-projects#upgrade-your-project) to the latest version to use this feature.

</Admonition>

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.

SSL enforcement only applies to connections to both Postgres and PgBouncer ("Connection Pooler"); all HTTP APIs offered by Supabase (e.g., PostgREST, Storage, Auth) automatically enforce SSL on all incoming connections.

## 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](https://supabase.com/dashboard/project/_/settings/database) of the dashboard.

## Manage SSL enforcement via the CLI

To get started:

1. [Install](/docs/guides/cli) the Supabase CLI 1.37.0+.
1. [Log in](/docs/guides/getting-started/local-development#log-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
### Check enforcement status

You can use the `get` subcommand of the CLI to check whether SSL is currently being enforced:

Expand All @@ -37,7 +43,7 @@ Or similarly, if SSL is not being enforced, you will see:
SSL is *NOT* being enforced.
```

## Update enforcement
### Update enforcement

The `update` subcommand is used to change the SSL enforcement status for your project:

Expand Down

0 comments on commit e442b8a

Please sign in to comment.