Chris StocktonandChris Stockton
8a4bca34a7
* feat: add documentation and UI integration for Before User Created hook - Added new guide: `before-user-created-hook.mdx`, documenting usage, inputs, outputs, and multiple complete examples for HTTP and SQL. - Updated navigation menu and hook index table to include the new hook. - Hook is now listed as available on Free and Pro plans. Studio changes: - Registered `Before User Created` hook in `hooks.constants.ts` with proper title, slug, and configuration keys. - Enabled Docs button linking to hook guide in both `CreateHookSheet` and `HookCard` components. - Extended hook listing page to support docs access via `secondaryActions`. This hook allows developers to intercept and reject user creation across all flows (email/password, OAuth, SSO, SAML, anonymous) - enabling custom signup logic like domain allowlists, geofencing, or account gating. * fix: add subnet to mdx lint allowed list * fix: incorporate feedback and spelling changes * feat: add allow/deny domain and CIDR examples to before-user-created hook This commit enhances the documentation for the before-user-created auth hook: - Adds production-ready SQL examples for blocking or allowing signups by email domain (signup_email_domains) and IP address or CIDR (signup_networks) - Introduces enum-based classification (allow vs deny) for both domain and network restrictions - Adds full migration-style snippets for easy copy/paste into Supabase SQL Editor - Includes updated HTTP examples that delegate to Postgres functions via Supabase client rpc() - Adds environment setup guidance and edge function scaffolding * fix: pnpm format --------- Co-authored-by: Chris Stockton <chris.stockton@supabase.io>
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.
Versioning
All tools have versioned docs, which are kept in separate folders. For example, the CLI has the following folders and files:
cli: the "next" release.cli_spec: contains the DocSpec for the "next" release (see below).cli_versioned_docs: a version of the documentation for every release (including the most current version).cli_versioned_sidebars: a version of the sidebar for every release (including the most current version).
When you release a new version of a tool, you should also release a new version of the docs. You can do this via the command line. For example, if you just released the CLI version 1.0.1:
npm run cli:version 1.0.1
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.