mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
c790bd44a3
Closes DOCS-1087 <img width="1493" height="688" alt="Screenshot 2026-06-30 at 4 50 52 PM" src="https://github.com/user-attachments/assets/39267c8a-befb-4419-8fa8-4e987f82781e" /> ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## Problem The Network Restrictions docs contain an incorrect curl example that, when followed, restricts the entire database instead of adding only the specified IP/CIDR — causing production outages for users. ## Solution Fix the incorrect curl command in the Network Restrictions docs so that it correctly adds only the specified CIDR rather than restricting the entire database. This PR solves the problem by adding an `--append` CLI procedure. Additionally, the document is improved: - All procedures are put in procedure format for easier readability and clear action steps - Wording is simpler - Headers follow convention - A "This topic..." intro paragraph is added ## Tophatting 1. Go to the preview link at `/docs/guides/platform/network-restrictions`. 2. Verify that the new `--append` section corrects the original issue. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reworked the network restrictions guide into clearer “dashboard” and “CLI” setup flows. * Expanded the intro with IPv4/IPv6 CIDR allowlisting guidance, including exceptions for IPv6 migration extensions and when the IPv4 add-on is installed. * Updated the CLI instructions with structured examples for checking, replacing, appending, and fully removing restrictions (including the “never applied” case when allowed lists are empty). * Clarified scope/limitations: restrictions apply to Postgres and its pooler (not HTTPS APIs or client libraries), and enabling restrictions blocks Edge Function direct database access. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Andrew Valleteau <avallete@users.noreply.github.com> Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
Reference Docs
Supabase Reference Docs
Maintainers
If you are a maintainer of any tools in the Supabase ecosystem, you can use this site to provide documentation for the tools & libraries that you maintain.
DocSpec
We use documentation specifications which can be used to generate human-readable docs.
- OpenAPI: for documenting API endpoints.
- SDKSpec (custom to Supabase): for SDKs and client libraries.
- ConfigSpec (custom to Supabase): for configuration options.
- CLISpec (custom to Supabase): for CLI commands and usage.
The benefit of using custom specifications is that we can generate many other types from a strict schema (eg, HTML and manpages). It also means that we can switch to any documentation system we want. On this site we use Next.js, but on Supabase's official website, we use a custom React site and expose only a subset of the available API for each tool.
Contributing
To contribute to docs, see the developers' guide and contributing guide.