mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
Danny White
24be387cdb
## 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 -->
67 lines
2.8 KiB
Plaintext
67 lines
2.8 KiB
Plaintext
---
|
|
id: 'platform-security'
|
|
title: 'Secure configuration of Supabase platform'
|
|
description: 'Supabase provides a secure yet flexible platform. Here is how to adjust various security settings across the platform.'
|
|
---
|
|
|
|
The Supabase hosted platform provides a secure by default configuration. Some organizations may however require further security controls to meet their own security policies or compliance requirements.
|
|
|
|
Access to additional security controls can be found under the [security tab](/dashboard/org/_/security) for organizations.
|
|
|
|
## Available controls
|
|
|
|
<Admonition type="note">
|
|
|
|
Additional security controls are under active development. Any changes will be published here and
|
|
in our [changelog](/changelog).
|
|
|
|
</Admonition>
|
|
|
|
### Enforce multi-factor authentication (MFA)
|
|
|
|
Organization owners can choose to enforce MFA for all team members.
|
|
|
|
For configuration information, see [Enforce MFA on Organization](/docs/guides/platform/mfa/org-mfa-enforcement)
|
|
|
|
### SSO for organizations
|
|
|
|
Supabase offers single sign-on (SSO) as a sign-in option to provide additional account security for your team. This allows company administrators to enforce the use of an identity provider when signing in to Supabase.
|
|
|
|
For configuration information, see [Enable SSO for Your Organization](/docs/guides/platform/sso).
|
|
|
|
### Postgres SSL enforcement
|
|
|
|
Supabase projects support connecting to the Postgres DB without SSL enforced to maximize client compatibility. For increased security, you can prevent clients from connecting if they're not using SSL.
|
|
|
|
For configuration information, see [Postgres SSL Enforcement](/docs/guides/platform/ssl-enforcement)
|
|
|
|
<Admonition type="note">
|
|
|
|
Controlling this at the organization level is on our roadmap.
|
|
|
|
</Admonition>
|
|
|
|
### Network restrictions
|
|
|
|
Each Supabase project comes with configurable restrictions on the IP ranges that are allowed to connect to Postgres and its pooler ("your database"). These restrictions are enforced before traffic reaches the database. If a connection is not restricted by IP, it still needs to authenticate successfully with valid database credentials.
|
|
|
|
For configuration information, see [Network Restrictions](/docs/guides/platform/network-restrictions)
|
|
|
|
<Admonition type="note">
|
|
|
|
Controlling this at the organization level is on our roadmap.
|
|
|
|
</Admonition>
|
|
|
|
### PrivateLink
|
|
|
|
PrivateLink provides enterprise-grade private network connectivity between your AWS VPC and your Supabase database using AWS VPC Lattice. This eliminates exposure to the public internet by creating a secure, private connection that keeps your database traffic within the AWS network backbone.
|
|
|
|
For configuration information, see [PrivateLink](/docs/guides/platform/privatelink)
|
|
|
|
<Admonition type="note">
|
|
|
|
To establish PrivateLink with a Read Replica, reach out to your account rep.
|
|
|
|
</Admonition>
|