Commit Graph

1415 Commits

Author SHA1 Message Date
Saxon Fletcher
d0972be7d5 Update branch framing (#37673)
* update branch framing

* shorten preview name

* Update apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/content/guides/deployment/branching/branching-2.mdx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/content/guides/deployment/branching/branching-2.mdx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/content/guides/deployment/branching/branching-2.mdx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* Update apps/docs/content/guides/deployment/branching.mdx

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>

* update name and add redirect

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-08-07 08:53:29 +10:00
Charis
8b72d96d66 docs: add product-specific troubleshooting views (#37671)
We have a global troubleshooting view at /guides/troubleshooting, but
for greater visibility, we should also have product-specific
troubleshooting views. This is the same view and same data as the global
page, but filtered down to a specific product.
2025-08-05 18:31:11 -04:00
Charis
6e99ca67d5 docs: move restore to new project docs to own page (#37633) 2025-08-03 15:23:21 -04:00
Lakshan Perera
49ba13fe3c chore: update file storage guide (#37268)
* chore: update file storage guide

* doc lints

* prettier

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

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

---------

Co-authored-by: Wen Bo Xie <wenbox323@gmail.com>
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2025-07-28 15:31:56 +00:00
Filipe Cabaço
43c0c25918 realtime: improve protocol docs; move settings to a guides (#37280)
* realtime: improve protocol docs; move settings to a guides

* fix GH action feedback

* Update apps/docs/content/guides/realtime/protocol.mdx

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

* Update apps/docs/content/guides/realtime/protocol.mdx

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

* fix image and protocol

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
Co-authored-by: Wen Bo Xie <wenbox323@gmail.com>
2025-07-18 21:28:06 +00:00
Francesco Sansalvadore
fb6f625707 chore: add docs for new db reports charts (#36703)
* chore: add docs for new db reports charts

* chore: fix linting issues

* move db reports docs to telemetry section

* add more info to reports docs

* fix lint suggestions

* update reports

* update latest links and chart screenshots

* advanced telemetry

* update db section
2025-07-17 12:40:12 +00:00
Etienne Stalmans
9f29d5c8df chore: new security page without flag (#36855)
* chore: new security page without flag

Remove feature flag for new security page

* chore: add additional docs

* chore: prettier

* chore: move mfa enforcement page

* fix: link fixes
2025-07-16 16:24:11 +02:00
Charis
85bd0d4f9b feat(docs): new branching docs (#36890)
* feat(docs): new branching docs

Reorganize branching docs and add Gitless branching page

* style: fix lint and formatting issues

* chore: document email notification for failures

* docs(branching): fix review comments

* branch merge updates

---------

Co-authored-by: Qiao Han <qiao@supabase.io>
Co-authored-by: Saxon Fletcher <saxonafletcher@gmail.com>
2025-07-16 09:45:19 -04:00
Charis
95750574d2 feat(docs): add scaffolding for iceberg docs (#36888)
* feat(docs): add scaffolding for iceberg docs

* docs:(storage/iceberg): Analytical buckets docs

* Apply suggestions from code review

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

* fix(docs): update analytics buckets docs

* nav reorg

* doc: analytics buckets limit section

* fix ci errors

---------

Co-authored-by: fenos <fabri.feno@gmail.com>
Co-authored-by: Inian <inian1234@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-07-15 14:16:23 +00:00
Stojan Dimitrovski
3046683210 docs: jwt signing keys (#37027)
* docs: jwt signing keys

* apply suggestion from @charislam

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

* add cryptography to spellchecker

* fix word

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

* remove easily

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

* fix significantly

---------

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-07-14 10:33:41 +02:00
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
Charis
a3c77cd060 fix(docs): feedback form note (#36835)
We've noticed some support-like requests being submitted through the feedback
form, so adding a note that that feedback form is not for technical
support.
2025-07-04 11:43:11 -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
Charis
33b9e1ed29 chore(docs): convert all scripts to esm (#35996)
Scripts currently use CJS, which is causing a bit of a mess when trying
to use shared utilities from the app. Converting everything to ESM so
there are fewer conflicts when adding new scripts going forward.
2025-05-29 15:44:55 -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
Charis
6fcb98d927 docs(pg17): add docs on pg17 upgrades (#35431) 2025-05-22 14:07:06 -04:00
Charis
01a1f86d7d fix(docs feedback): route security feedback to security team (#35658)
## Before

Feedback on security pages is being routed to general docs feedback.

## After

Feedback on security pages is routed to security team.
2025-05-14 08:15:52 -04:00
Charis
0b85947c7c fix(docs): jwt generator (#35628)
Fix a UI display issue for the JWT generator: when the dropdown is used
to switch between the anon and service role key, the displayed JWT
claims did not change. The actual state changes, and the keys generated
are correct, but they just don't display because the text area is
controlled andd oesn't sync with the state.

Changed the text are to take a key dependent on the state so the
displayed UI should change properly.

Does _not_ affect the actually generated API keys. Double-checked that
these are the same before and after.
2025-05-13 13:24:06 +00:00
Kevin Grüneberg
e1bd23d66f fix: do not translate USD prices (#35466)
When translation tools go over prices, they wrongfully convert USD into other currencies without changing the price. $25 becomes Rp25 (Rupiah).

By using `translate='no'` we avoid the translation of pricing info. There are some tooltips left that are not covered yet, but this should be the majority already.

Kept the docs Pricing component as simple as possible, just wrapping in a span to avoid translation, not modifying any formatting.
2025-05-06 12:03:35 +08: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
Wen Bo Xie
c638255cb2 fix: change notion to linear team mapping (#35363) 2025-04-30 20:54:53 +00: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
2f80b9b3b6 fix: jwt generator (#34908)
The old JWT generator code provided the anon and authenticated claims as strings. The format of this string is different from the format determined by KJUR if an object is provided (I'm guessing probably a whitespace or quote character thing, but I didn't dive down this rabbit hole.) This leads to incompatibilities when the token is used.

To prevent this, the tokens are now defined as objects and KJUR's own serialization is used.
2025-04-18 12:30:07 -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
Charis
258bc37919 docs: add type hints (#34678) 2025-04-08 13:25:46 -04: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
Charis
ef247b8f5f feat(docs): fetch conn string (#34492)
* feat(docs): fetch conn string

Add option to ProjectConfigVariables to fetch the Supavisor session mode connection string, for setting up MCP server

* docs(mcp): reminder to replace password placeholder in connection string

* fix: display helpful message if project paused

---------

Co-authored-by: Greg Richardson <greg.nmr@gmail.com>
2025-03-28 13:17:29 -04:00
Charis
37923df609 fix: move docs off deprecated endpoint (#34490)
Docs is using a deprecated endpoint to get the API keys for the project variables component. Move to a new endpoint.
2025-03-27 16:44:54 -04:00
Charis
02da19bd95 fix: phone provider modals (#34441) 2025-03-26 14:07:38 -04: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
Charis
2709fa4a3e feat: pre-compile-time partials (#34028)
Partials are currently defined via MDX includes. This PR switches to pre-compile-time partials, which have a new syntax:

```
<$Partial path="path/to/file.mdx" />
```

## Rationale

This produces two improvements:

1. Partial substitution can occur in pipelines that don't use MDX compilation. For example, we can now do partial substitution before building the search index, so partial content will also be indexed.
2. After the App Router migration, the MDXProviders should've been deprecated, but were kept around for the sole reason of making partials work, and leading to us shipping unnecessary client-side code. We get a minor decrease in overall client bundle size (5.74 MB to 5.6 MB) by getting rid of the Providers.

## Breaking changes

Besides the change to partial syntax, the arguments are also less powerful than before because we are doing string substitution and don't have the full power of JS. Defining string variables is still possible (documented in the Contributing guide), and since that's all we actually do in practice, this shouldn't be too cumbersome. There is always the escape hatch of making a custom component for more complex content reuse cases.
2025-03-18 10:37:39 -04:00
Pamela Chia
b19c043d93 fix: consistent disk unit (#34156)
* fix: consistent disk unit

* Update apps/docs/content/guides/platform/manage-your-usage/disk-throughput.mdx

* Update apps/docs/content/guides/platform/manage-your-usage/disk-throughput.mdx

* Update apps/docs/content/guides/platform/manage-your-usage/disk-throughput.mdx

* docs: makes use of singular/plural for metrics that are billed hourly consistent.

* ci: Autofix updates from GitHub workflow

* fix: instance is Mbps

* fix: description Mbps

---------

Co-authored-by: Thomas <31189692+ecktoteckto@users.noreply.github.com>
Co-authored-by: github-tidy-bot <github-tidy-bot@supabase.com>
2025-03-14 11:16:25 +01: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
Ivan Vasilov
2b054dd82f fix: Fix crash in JS reference page (#34037)
* Split the TOC state from the components to avoid cyclic dependencies on Tabs component.

* Fix type errors.
2025-03-06 12:18:54 +01:00
Francesco Sansalvadore
d24df14aab Feat/toc component (#33964)
* test fuma toc

* make toc work

* ok toc

* ui-patterns toc

* fix types

* cleanup

* fix overflow issues

* cleanup

* fix loading w

* Update apps/docs/components/GuidesTableOfContents.tsx

* fix prettier

* format

* install deps

* target ES2018

* tweak regex

* update docs test snapshots

* fix useSubscribeTocRerender
2025-03-05 23:10:02 +01:00
Charis
12152c3345 chore(docs): clean dead code (#34021)
Remove unused components in docs.
2025-03-05 12:29:33 -05:00