Commit Graph

903 Commits

Author SHA1 Message Date
Lydia Hallie
a26c01217d Update Edge Functions docs (#36798)
* Update Environment Variables docs

* Update Dependencies docs

* Add Function Configuration d ocs

* Add custom Configuration section in Navigation

* Add Error Handling section

* Add new HTTP Methods section

* Update Deno 2 Guide

* Update nav

* Rm deno2 nav

* Update Deploy section

* Update CI/CD section

* Update Logging

* Update Testing

* Update Local Debugging

* Update Troubleshooting

* Update Nav

* Update CLI Quickstart

* Update Dashboard Quickstart

* Update Development Environment

* Update Nav

* Fix links

* Update apps/docs/content/guides/functions/quickstart-dashboard.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/development-environment.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/development-environment.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/quickstart.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Use $CodeSample for multi-root example

* Use tocVideo instead of video embed

* Rm typo

* Switch Quickstart ordering

* Rephrase Docker requirement for deployment

* Add Project Structure section

* style: fix docs lint issues

* Update Regional Invocations

* Update Error Handing

* Fix linting

* Fixes

* Remove duplicate sections

* Update Auth integration

* Update Storage

* Update Database/Postgres

* Update Nav

* Update Background Tasks

* Update Ephemeral Storage

* Update Websockets

* Update Routing

* Update wasm

* Update AI models

* Fix linting issues

* Update apps/docs/content/guides/functions/ai-models.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/ai-models.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/ai-models.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/storage-caching.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/websockets.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/websockets.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/functions/ai-models.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Rm unnecessary lines

* Rm wrong example

* Fix typo

* Rm deno2

* Move CICD to deployment and rename routing

* Fix whitespace

* rm unnecessary spelling

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-07-10 14:18:01 +00:00
Bo Lu
6e84bd1d72 docs: add Iceberg and DuckDB FDW docs (#36965)
* docs: add Apache Iceberg FDW docs

* docs: add DuckDB FDW docs

* fix(tests): fix docs tests erroring in CI

GitHub Auth was enabled in our supabase config.toml, which causes the supabase startup to try finding GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET in env. We don't actually need these for tests, so we can just mock them.

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-07-09 11:00:54 -04:00
Chris Stockton
8a4bca34a7 feat: add documentation and UI integration for Before User Created hook (#36567)
* 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>
2025-07-02 14:54:07 -07:00
Stephen Morgan
972b4775d1 docs: privatelink feature (#36760)
* docs: privatelink feature

* chore linting fixes

* chore additional linting fixes

* Update apps/docs/content/guides/platform/privatelink.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-07-02 11:11:10 +12:00
Vangmay Sachan
d2b9eee9e9 Wrote docs for JWT Field (#36578)
* Wrote docs

* Update apps/docs/content/guides/auth/jwt-fields.mdx

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-06-25 16:30:05 +00:00
Stojan Dimitrovski
4b8d5f5502 docs: add workos tpa docs (#36662)
* docs: add workos to 3rd party auth docs

* Commit @charislam's suggestions

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* more explanation of the user_role claim

* drop CLI instructions for now

* add WorkOS to nav menu

* fix typo

* use issuer not client id

* fix prettier

---------

Co-authored-by: Cameron Matheson <cameron@workos.com>
Co-authored-by: Cameron Matheson <cameron.matheson@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-06-25 17:15:51 +02:00
Etienne Stalmans
c1791759d5 chore: document new MFA enforcement on organization option (#35564)
* chore: document new MFA enforcement on organization option

* chore: multi-factor

* review suggestions and navigation item

* note that feature is opt-in atm

* chore: note about PATs

* fix: spelling

* fix: links
2025-06-17 16:28:23 +02:00
Charis
8b8bddd6fd docs(extensions): mark extensions deprecated in pg17 (#36232) 2025-06-06 21:28:09 +00:00
Charis
cf3ecc93eb chore(docs): turn on strictNullChecks (#36180)
strictNullChecks was off for docs, which lets errors slip through and
leads to incorrect required/optional typing on Zod-inferred types. This
PR enables strictNullChecks and fixes all the existing violations.
2025-06-04 17:05:37 -04:00
Copple
a61a39ff15 docs: compliance (#36016)
* Compliance docs

* lint spelling

* fixes headings

* Update apps/docs/content/guides/database/hardening-data-api.mdx

* ci: Autofix updates from GitHub workflow

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-05-29 19:35:25 +02:00
Chris Gwilliams
34022bd570 Docs: Add section on logical replication for setting up CDC from Supabase to a destination (#27087)
* add replication section with instructions for services

* address comments and neturalise tone

* formalised overview and simplified faq

* reviewdog silenced (mostly)

* move individual tools into tab group and reduce mention of subscriptions

* fix tab components

* correct postgres typos and others

* removed individual service pages and added section for monitoring slots

* update nav menu and add information for monitoring

* update monitoring docs

* added example queries for tracking replication and removed overview

* added spelling rules for Xmin and cleaned up CDC format

* edits & reorganization

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-05-28 11:28:48 +03:00
Stojan Dimitrovski
654484408a docs: add web3 docs (#35650)
* docs: add web3 docs

* docs: prettifier for auth-web3

* apply suggestion from @cemalkilic

Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com>

* apply suggestion from @charislam

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* more docs updates

* more fixes

---------

Co-authored-by: Cemal Kilic <cemalkilic96@gmail.com>
Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-05-23 10:28:59 +02:00
Francesco Sansalvadore
a4cfcd9b2e global user dropdown in docs and www (#35063)
* docs: user nav dropdown

* www: user dropdown nav

* update menus

* chore: add complete local storage allowlist

* move all local-storage to common

* reload after logOut

* add local storage key changes from #35175

* fix errors

* add more keys

* fix merge bugs

---------

Co-authored-by: Alaister Young <a@alaisteryoung.com>
2025-05-05 11:48:06 +02:00
Charis
30b6af4ff3 fix (docs): non-platform integrations page (#35285)
There were two bugs when trying to run the integrations page locally
with NEXT_PUBLIC_IS_PLATFORM=false:

1. The IS_PLATFORM check imported from common was not evaluating
correctly to a boolean. This is because I slapped a 'use client' on the
entire common package last year -_-""" which caused all its imports to
be evaluated to functions when used in server components. I have now
moved the 'use client's down to the submodules that actually need it.

2. When the integrations submenu is empty, the navigation menu errors
out because it expects all navigation items to either have children or
have links. Have updated this to gracefully hide empty headers.
2025-04-25 15:22:06 -04:00
Charis
be99898efe docs: move restoring backup section (#35109)
Before:

Instructions for restoring a backup locally were buried inside the
Upgrading guide.

After:

Instructions for restoring a backup locally are on their own page in the
Local Development section. This page is linked from the Upgrading guide
because it is useful if a paused project has exceeded its restoring time
limit.
2025-04-18 12:30:33 +00:00
Etienne Stalmans
912dce3c4b chore: make security page discoverable (#35004)
* chore: make security page discoverable

* chore: add security icon

* chore: add security grayscale icon

* chore: add security icon

* chore: resize security IconSecurity
2025-04-16 09:27:26 +02:00
Wen Bo Xie
82ee7403d8 fix: deprecate Fly Postgres (#35002) 2025-04-14 12:25:00 +00:00
Etienne Stalmans
c071a742d5 chore: docs for security testing (#34905)
* chore: docs for security testing

* chore: cleanup text
2025-04-14 14:10:03 +02:00
Greg
8ca8cb43fd Added functions dashboard quickstart page, about deno 2 guide, and deno 2 test guide (#34599)
* Added functions dashboard quickstart page, about deno 2 guide, and deno 2 test guide

* fix: updated image sizes, and trimmed some images and text

* fix: removed line about assistant edits and made some minor polish fixes

* updated docs

* Apply suggestions from code review

* remove duplication

---------

Co-authored-by: Greg Papas <gregpapas@gregs-mbp.mynetworksettings.com>
Co-authored-by: Lakshan Perera <lakshan@laktek.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-04-01 13:59:17 +00:00
Stojan Dimitrovski
81db6fbaa1 docs: add clerk third-party auth integration docs (#34439) 2025-03-29 12:39:33 +00:00
Filipe Cabaço
b2d3ce4e9b realtime: improve documentation (#34393)
Improve realtime documentation
---------

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-03-26 17:30:16 +00:00
Terry Sutton
128eaed360 Chore/fix menu item (#34193)
Fix menu item
2025-03-14 09:53:06 +00:00
Thor 雷神 Schaeff
99f1d1fc16 Thor/add elevenlabs streaming example n docs (#33989)
* feat: add TTS & STT docs.

* feat: add examples.

* fix: docs.

* code review nits.

* chore: format.

* Fix mdx-lint errors.

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2025-03-07 09:08:56 +01:00
Etienne Stalmans
f5c8f460c0 chore: hipaa responsibilities doc (#33996)
* feat: add HIPAA responsibility docs

* chore: additional config guidance

* chore: mention geo specific status of HIPAA

* fix: spelling

* chore: faq and soc 2 comparisons

* chore: better linking to shared responsibility

* fix: spelling

* Update apps/docs/content/guides/security/hipaa-compliance.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/security/hipaa-compliance.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/content/guides/security/hipaa-compliance.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-03-05 08:21:45 +00:00
Etienne Stalmans
bebdca63b0 feat: add links to product security (#34000)
* feat: add links to product security

* chore: add link for product-security

* fix: spelling

* fix: spelling

* Update apps/docs/content/guides/security/product-security.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-03-05 08:16:09 +00:00
Etienne Stalmans
0eaf282070 feat: SOC 2 docs page (#33965)
* feat: add SOC 2 page to docs

* feat: more linking

* fix: make linters happy

* fix: prettier

* chore: make security page available

* typo: sp

* publish security

* chore: publish new security section

* change mobile menu to show Security on Security section

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-03-04 10:03:50 +01:00
Alaister Young
3d766bc1c1 [FE-1426] feat(studio): clerk fdw (#33803)
* feat(studio): clerk fdw

* prettier

* docs: add Clerk FDW docs

* Smol update

---------

Co-authored-by: Bo Lu <lv.patrick@gmail.com>
Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-03-03 15:50:09 +08:00
Francesco Sansalvadore
64ad37a09b docs contributing layout (#33833)
* contributing layout

* contributing layout mobile

* gap

* Update apps/docs/app/contributing/ContributingToC.tsx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* Update apps/docs/app/contributing/ContributingToC.tsx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* add missing menu entry

* remove feedback anchor from toc

* cleanup

* sheet height

* sheet height

* breadcrumb

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-02-26 14:03:16 +00:00
Bo Lu
05f49e0b9b docs: add Notion Wasm FDW docs (#33799) 2025-02-24 13:11:20 +11:00
Greg Richardson
52cb7f82b2 Docs: MCP with AI tools (#33610)
* docs: mcp

* fix: change admonition type to note

* chore: add 'npx' to dictionary

* feat: adds windsurf example

* fix: adds codium to dictionary
2025-02-18 21:07:02 +00:00
Thomas
df9f410c50 docs(billing): complete rewrite
* deleted all old pages except from FAQs
* added pricing section to feature docs pages
* adjusted all links to new pages (on Dashboard, in docs, on Pricing page)
* configured redirects from old billing docs pages to new pages
---------
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Kevin Grüneberg <k.grueneberg1994@gmail.com>
2025-02-12 21:05:18 +01:00
Bobbie Soedirgo
95ccf25e64 fix: temporarily hide pg_stat_monitor (#33475)
https://linear.app/supabase/issue/PSQL-225/remove-pg-stat-monitor-from-docs-for-now
2025-02-12 16:58:10 +08:00
Greg Richardson
174b32470e Docs: Automatic embeddings (#33498)
* docs: automatic embeddings

* feat: add dashboard instructions to enable extensions

* feat: internal linking

* fix: response status and headers

* chore: add 'enqueues' to spelling lint

* chore: add 'matryoshka' to spelling lint

* fix: 'eg.' to 'e.g.'

* feat: pgmq links to dedicated queue docs

* fix: ignore heading for mdx lint

* docs: remove double word

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* docs: change 'reuse' to 'use'

Co-authored-by: Oliver Rice <github@oliverrice.com>

* docs: remove dimensions on halfvec column

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Oliver Rice <github@oliverrice.com>
2025-02-11 13:27:56 -07:00
Andrew Valleteau
3a0be853c9 chore: rework and extend database testing docs and examples (#33261)
* chore: rework and extend database testing docs and exemples
2025-02-06 13:42:59 +09:00
Charis
2d55512553 chore: activate spelling and admonitions lints for docs (#33292) 2025-02-04 13:18:31 -05:00
Han Qiao
9171a30fc5 docs: document using declarative schemas (#33253)
* docs: document using declarative schemas

* Rename declarative-schema-migrations.mdx to declaring-database-schemas.mdx

* chore: improve docs readability

* Apply suggestions from code review

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

* chore: rename title

* chore: back link to getting started

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-02-04 15:12:54 +08:00
Charis
a404e48b39 docs: split telemetry and troubleshooting sections (#33223)
* docs: split telemetry and troubleshooting sections

* docs: update telemetry copy

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>

* fix(ui): fix troubleshooting view in mobile

* format

* fix: troubleshooting search

Troubleshooting previews are displayed using a grid now, and hidden
doesn't work (overriden by grid behavior). Instead, applying
display:none when filtered out.

* sync to db

---------

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
2025-02-03 18:00:33 -05:00
Wen Bo Xie
3f6adea49c fix: change functions dependencies url (#33050)
* fix: change functions dependencies url

* change file name to dependencies.mdx
2025-01-23 14:50:10 -08:00
Charis
8deced7dab migrate(docs): troubleshooting 9 (#30937)
* migrate(docs): troubleshooting 9

timeouts, latency

* light updates

* Update NavigationMenu.constants.ts

* Update canceling-statement-due-to-statement-timeout-581wFv.mdx

Added keyword

* Apply suggestions from code review

---------

Co-authored-by: Brian Brennglass <brian@Brians-MacBook-Pro.local>
Co-authored-by: TheOtherBrian1 <91111415+TheOtherBrian1@users.noreply.github.com>
Co-authored-by: Kevin Brolly <kevin.brolly@supabase.io>
2025-01-17 20:00:40 +00:00
Lakshan Perera
e63a082dda chore(docs): Added a guide on using wasm modules in Edge Functions (#32811)
* chore(docs): Added a guide on using wasm modules in Edge Functions

* update example

* WASM -> Wasm

* fix page title
2025-01-16 09:55:31 +11:00
Thor 雷神 Schaeff
8e67d1e0a7 feat: add Hono example and guide. (#32614) 2025-01-07 20:22:48 +08:00
Peter
29117959b1 Docs: overhaul Migrating within Supabase page(#31049)
* Overhaul of Migrate within Supabase

* Added sub menus for overhaul of Migrate within supabase

* Re-structuring of content and pages

* Re-organize flow of the guide

* Prettier fix and small additions to dashboard restore guide

* update CLI guide to have dummy data for now

* Add structure for Windows specific instructions

* Add Postgres installation as partial

* Full first draft

* fix headings in main page

* Fix vale issues

* Proofread #1

* Small fixes

* Editing pass

* More edits after first tests.

* Final editting pass after testing

* Add common issues I ran into while testing and fixed installation instructions for MacOS

* Editing pass after more testing and proofreading

* Grammar fixes

* attempt at vale fixes

* Add tip for windows installation

* edits

* Fix dashboard restore hyperlink

---------

Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com>
2025-01-06 07:11:53 -05:00
TheOtherBrian1
003493e034 add beekeeper studio to docs (#31240)
Co-authored-by: Brian Brennglass <brian@Brians-MacBook-Pro.local>
2025-01-02 18:29:52 -05:00
Oliver Rice
2d1783ab00 Revert "Remove pg_repack from docs" (#32393)
* Revert "Remove pg_repack from docs (#18476)"

This reverts commit f2508d2e82.

* update pg_repack docs

* prettier
2025-01-02 08:07:45 -06:00
Filipe Cabaço
0affb7c31e realtime: Broadcast Changes documentation (#31222) 2024-12-19 13:50:44 +00:00
TheOtherBrian1
0ad1510d29 adding metabase instructions (#31223)
Co-authored-by: Brian Brennglass <brian@Brians-MacBook-Pro.local>
2024-12-18 15:24:56 -05:00
Oliver Rice
a208912e2f Add docs for pgmq (#30144)
* Revert "Revert "Add docs for pgmq" (#30108)"

This reverts commit a2653740f5.

* remove create_partitioned since its not yet supported

* re-arange pgmq extension docs

* update queue docs to match cron structure

* consistent header level for api functions
2024-12-16 16:27:21 -06:00
egor
bb0542749f docs: add realtime benchmarks docs (#31032)
* docs: add realtime benchmarks docs
2024-12-16 16:36:11 +00:00
TheOtherBrian1
f1cf6c642d added postgres_fdw docs (#31085)
* added postgres_fdw docs

* updated link in extension docs

* Update apps/docs/content/guides/database/extensions/postgres_fdw.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update apps/docs/content/guides/database/extensions/postgres_fdw.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update apps/docs/content/guides/database/extensions/postgres_fdw.mdx

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* ci: Autofix updates from GitHub workflow

* Update apps/docs/content/guides/database/extensions/postgres_fdw.mdx

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>

---------

Co-authored-by: Brian Brennglass <brian@Brians-MBP.lan>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-tidy-bot <github-tidy-bot@supabase.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-12-12 22:31:18 +00:00
Julien Goux
aa0fedfc39 chore: node v22 LTS compatibility for contributing (#30970)
* chore: node v22 LTS compatibility for contributing

* missing assertions

* apply prettier
2024-12-12 11:29:07 +01:00