Commit Graph

153 Commits

Author SHA1 Message Date
Chris Chinchilla d8bd6b047c docs: Examples Key changes (#45170)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated examples and guides to use Supabase publishable (client) keys
instead of anon keys for client-side usage across frameworks and
platforms.
* Renamed environment variable examples and .env templates to reflect
publishable key naming.
* Adjusted sample requests and client-init examples to send/use the
publishable key via the apikey header where applicable.
* Updated references from service_role to secret for server-side
credential guidance.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: fadymak <fady@fadymak.com>
2026-05-04 12:58:16 +02:00
Laurence Isla 08e9cdde5e docs: data api docs functions (#44412)
## I have read the
[CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md)
file.

YES

## What kind of change does this PR introduce?

Replaces "stored procedures" with "functions" for everything related to
the Data API.

## Additional context

It's not accurate to call database functions "stored procedures". It may
have been that way before Postgres 11, but now it causes confusion
because PostgREST allows functions and not stored procedures.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Standardized terminology across docs, SDK guides, CLI/config specs,
examples, UI, and config comments to use "database functions" instead of
"stored procedures".
* Updated API docs, CLI/config descriptions, Studio UI labels, help
text, empty-state and navigation copy, RPC documentation, and example
text for consistency.
* Adjusted explanatory text and error/help messages to reflect the
revised terminology.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-21 11:54:27 +10:00
Katerina Skroumpelou a7563e9fe6 docs(examples): use latest v2 of supabase-js and remove lock files (#44704)
* Use latest 2.x version of `@supabase/supabase-js` in all examples
* Use `latest` version of `@supabase/ssr` in all examples
* Remove lock files from examples
* Add examples lock files in .gitignore

The rationale is:
- Lock files are not actively maintained/updated (or the versions in the
package.json files for that matter)
- They pin an arbitrary version (from the end-user perspective)
- Removes the need to manually update the versions and reinstall
- Consistency

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

## Release Notes

* **Chores**
* Broadened Supabase SDK dependency version constraints across example
projects for greater flexibility with compatible updates
  * Updated some SSR package dependencies to track latest releases
* Added gitignore rules for dependency lock files in example directories

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-14 09:24:46 +03:00
Ivan Vasilov d07e78a616 chore: Run prettier on examples folder (#43851)
This PR runs `prettier` on the `examples` folder.

Depends on https://github.com/supabase/supabase/pull/43849.
2026-03-18 10:51:10 +01:00
Kalleby Santos 935155cd18 fix(example): wrong folder link at custom-jwt-validation readme (#40474)
* fix(example): wrong folder link at custom-jwt-validation readme

* fix: jwt template download url

* stamp: use curl instead of wget
2026-03-16 09:52:26 +00:00
Katerina Skroumpelou a0b946f1a2 docs: update cors documentation to include new method (#42644)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated Edge Functions CORS header guides with version-specific
approaches for SDK v2.95.0+ and earlier versions.
* Revised code examples across multiple Edge Functions to reflect
current CORS header implementation patterns.
* Enhanced troubleshooting documentation with updated preflight handling
guidance.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-10 18:32:32 +02:00
Katerina Skroumpelou c730dc37fd Revert "docs: update cors documentation to include new method" (#42524)
Reverts supabase/supabase#42506

`esm.sh` does not work, so we will revert this version for now.
2026-02-05 21:03:33 +01:00
Katerina Skroumpelou 525c0d7e13 docs: update cors documentation to include new method (#42506)
v2.95.0 of the supabase-js sdk has been released, which contains
https://github.com/supabase/supabase-js/pull/2071

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated guides and examples to recommend using CORS headers from the
Supabase JS SDK (v2.95.0+) instead of manually defining headers.
* Examples now show the SDK-based approach and include a clear fallback
path for older SDK versions that require hardcoded headers.
* Added notes that SDK header updates will be reflected automatically in
edge functions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-02-05 17:56:34 +02:00
Cemal Kılıç 0e549e9ee5 chore: strip prefix in hookSecret, update docs and related examples (#39799)
Updated hookSecret to remove 'v1,whsec_' prefix to have the consistency
in the docs

---------

Co-authored-by: Timothy Lim <tim.lim@supabase.io>
2026-02-03 21:03:19 +00:00
Kalleby Santos 037e5f90a5 docs: improvements on securing Edge Functions guide (#41727)
* stamp: using CodeSample to dynamic load jwt examples

* stamp: lint

* stamp: using latest 'jose' lib on jwt examples

* stamp: update 'jose' lib link

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

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-01-07 14:26:40 +00:00
Kalleby Santos 0a8e264102 feat(docs): edge functions JWT Signing Keys guide (#41444)
* feat: edge functions legacy jwt auth guide

* stamp: adding `verify_jwt` disclaimer

* stamp: manual verify jwt example

* stamp: improving example

* stamp: improve supabase auth example

* feat: adding signing keys to jwt templates

* stamp: cleaning

* stamp: applying mdx-lint

* stamp: format

* stamp: applying ai suggestions

* stamp: improving jwt lib example

* stamp: cleaning

* stamp: typo

* stamp: applying suggestions

* stamp: applying suggestions

* stamp: applying improvements suggestions

* stamp: ponctuation typo

* stamp: ponctuation typo

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

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

* Apply suggestions from code review

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

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

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

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

---------

Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2026-01-05 14:29:02 +01:00
Pedro Rodrigues 50302662f7 docs(update): address review comments for MCP server guide (#41274)
* docs: improve BYOM guide for MCP server deployment and OAuth integration

* fix rebase

* fix pnpm.lock

* docs: clarify MCP guide and example naming

* fix pnpm-lock

* docs: remove basePath from MCP tutorial and example

- Remove misleading comment about Edge Functions routing
- Remove basePath as it's not needed - Edge Functions automatically strip /functions/v1/<functionName> prefix
- Simplify code to just use const app = new Hono()

* docs: clarify --no-verify-jwt flag and authentication options

- Explain that omitting --no-verify-jwt enables JWT verification at Edge Function layer
- Clarify this provides basic protection for internal servers but not full MCP auth
- Update authentication section to be consistent
- Add tip in deployment section about omitting the flag

* fiox format

* PR feedback

* chore: restore pnpm-lock.yaml from master
2025-12-12 11:50:57 +00:00
Pedro Rodrigues 67913228b5 docs: byom mcp server without auth (#41230)
* docs: improve BYOM guide for MCP server deployment and OAuth integration

* fix tutorial for simple mcp server

* remove authentication section

* fix rebase

* fix pnpm.lock

* add Zod to dictionary

* remove authentication from the beginning

* fix mcp-lite link

* change order of deno.json

* fix mcp-handler
2025-12-11 14:16:40 +00:00
Andrew Agostini 5e4e519f6c docs: Fix broken URLS batch 3 (#40508)
* docs: remove link to token-transformer since that repo has since been refactored and no particular file contains the code originally linked to

* docs: update Redis link in rate limiting examples to point to the correct URL

* docs: update Supabase URLs to current magic link docs

* docs: update README for postgres-on-the-edge function to remove polyscale line (service no longer exists) and add resource links to relevant deno blog post

* docs: update Open Graph image generation examples links to the new documentation URL

* docs: update README with new Quickstart: Swift guide URL

* docs: update Supabase Vector links to reflect new URL

* docs: add two new link suggestions the replace the current broken one. Choose one.

* docs: update documentation links for Postgres Language Server to reflect new URL

* docs: update event trigger matrix documentation link to compensate for fact that 'current' verb does not work for some of their links

* Update apps/docs/content/troubleshooting/supabase-grafana-memory-charts.mdx

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

---------

Co-authored-by: Chris Chinchilla <chris@chrischinchilla.com>
2025-11-28 10:56:17 +00:00
Andrew Agostini 67faf37ca7 docs: Fix broken URLS batch 4 (#40548)
docs: Fix broken links in various guides and blog posts
2025-11-28 17:34:31 +08:00
Kalleby Santos 27f8143b66 chore: add custom-jwt-validation example (#40438) 2025-11-14 10:45:38 +00:00
Danny White d914b81f47 feat: consolidate settings (#37580)
* feat: move storage settings

* feat: redirect

* feat: database settings in service area

* feat: move data api settings

* fix: revert data API placement

* feat: minor UX touches

* fix: simplify configuration group

* feat: references to database settings

* feat: references to storage settings

* fix: redirects and formatting

* fix: Import StorageMenu dynamically to avoid SSR issues with useLocalStorage

* fix: move Data API closer to semantic siblings

* fix: revert smart comma

* Shift bucket sort logic into storage explorer store

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-08-04 16:21:54 +10:00
Lakshan Perera 3c390c7891 chore: Use npm specifier instead of jsr for supabase-js imports (#36291)
chore: update examples to use npm specifier instead of jsr
2025-06-09 22:36:48 -04:00
Tyler 8d339f77f0 examples: Add OpenAI image gen API example (#35840) 2025-05-22 12:50:26 +00:00
Clarence 3b1f4b00a1 chore: fixed typo in elevenlabs text to speech (#34418) 2025-03-26 10:28:25 +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
Eric Kharitonashvili 00dfbdca0a Fix Wasm Edge Function Docs (#33910)
* fixed docs bug: when importing wasm, you need to include the js and use this. Otherwise, there will be wasm instantiate errors

* Update wasm.mdx

Got rid of filename on top of markdown

* Update index.ts

got rid of filename comment at the top
2025-02-28 10:43:58 -05:00
Rodrigo Mansueli aea6ad069b chore: update stripe webhook example (#33774)
* Chore: Update stripe-webhooks.mdx

* Update index.ts
2025-02-21 15:30:13 -03: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
Lakshan Perera cdb95a6036 chore: add an example for using wasm modules in Edge Functions (#32810)
Co-authored-by: Rodrigo Mansueli <rodrigo@mansueli.com>
2025-01-15 19:37:21 +00:00
Han Qiao b0abf4e580 chore: simplify config for edge functions (#30850)
* chore: simplify config for caching examples

* chore: simplify config for edge functions

* chore: upload example images to storage
2024-12-04 16:53:52 +08:00
Thor 雷神 Schaeff f7518c2896 chore: background tasks updates (#30454)
* chore: bacground task docs and example.

* chore: add video.
2024-11-13 16:57:25 +08:00
devin-ai-integration[bot] 04e918cd28 fix: Remove unnecessary tablespace keyword from sentry functions migration (#30217)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2024-11-05 13:49:38 +08:00
Lakshan Perera ef6353e84c Edge Function example on image manipulation (#29658)
* chore: add magick-wasm example functions

* chore: add image manipulation guide
2024-10-03 17:47:55 +08:00
Andrew Valleteau 34ca82f18c chore: replace deno deprecated unstable flag with recommended (#29316)
See: https://docs.deno.com/runtime/reference/cli/unstable_flags/\#--unstable
Related: https://github.com/supabase/cli/issues/2682
2024-09-18 09:09:47 +02:00
Tyler 60b45b6d93 examples: Add localized auth hook email example (#29079) 2024-09-04 09:38:29 -03:00
Thor 雷神 Schaeff 2ae41b620e Add Auth Hook Resend Example. (#28805) 2024-08-23 21:31:35 +08:00
Thor 雷神 Schaeff 0dbb5e5225 docs: update deno deps to jsr. (#27766)
docs: update deno desp to jsr.
2024-07-03 18:06:55 +08:00
Adam Chen Wei db923ba4b1 Update README.md (#25993)
https://www.polyscale.ai/future/
polyscale is no longer available. Maybe good to have another alternative to put in place. should remove for now to avoid confusion for the near future.
2024-05-27 19:36:49 +02:00
Simon Ha 597c554e7a [WIP] 20771/fix auth get user for edge functions (#23155)
* docs: fix RPC sql example

* docs: fix auth.getUser() calls to use auth.getUser(jwt)

- add lines to get token before calling auth.getUser() as session is not
set after setting authHeader in client

* Apply suggestions from code review

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-04-30 20:34:58 +00:00
Thor 雷神 Schaeff 548db662ce 🤫: edgy sentry. (#23175)
feat: edgy sentry.
2024-04-24 14:47:05 +08:00
hallidayo a7c6f3ec9a fix: edge functions removed port 465 (#22071)
removed port 465

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-03-19 07:45:37 +00:00
Charis 14ca7b6ed9 docs: add sentry integration docs (#21439)
* docs: add sentry integration docs

* feat: add sentry edge functions monitoring guide.

* feat: add sentry functions example.

* fix: navbar.

* chore: nits.

* chore: add to functions example list.

* fix: formatting.

* chore: add nextjs example.

* fix: rename sentry guide

* remove configuration options

* Apply suggestions from code review

Co-authored-by: Kamil Ogórek <kamil.ogorek@gmail.com>

---------

Co-authored-by: thorwebdev <thor@supabase.io>
Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>
Co-authored-by: Kamil Ogórek <kamil.ogorek@gmail.com>
2024-03-06 14:50:03 +00:00
냥냐챠 b10301bc3c chore: update an edge function example (#21539)
chore: update `send-email-stmp` example
2024-02-27 10:49:26 +00:00
Charis a4d4f68797 fix db connections for example edge functions (#20889) 2024-01-30 18:28:05 -05:00
Yoann Fuks 20e8a01563 Fix(example): methods cors on restful-tasks edge (#20128)
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2024-01-03 17:23:36 +00:00
Robbie 0ac88f68b4 Add Tunnelmole as an open source alternative to ngrok for your Discord Bot (#19864)
* Add Tunnelmole as an open source alternative to ngrok

* More compact instructions

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2023-12-20 17:16:15 +00:00
Anwar Knyane 4e4ff1f02a fix GitHub actions and add extra security to project-id (#19851)
* Update deploy.yaml

* update deploy.yaml for functions

---------

Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
2023-12-19 18:54:59 +00:00
Charis 7fdc3ce358 Revert "Feat/pdf file upload and extraction edge function example" (#19750)
Revert "Feat/pdf file upload and extraction edge function example (#15580)"

This reverts commit 62cdcf7149.
2023-12-14 18:46:48 +00:00
Adams Abdulhakeem 62cdcf7149 Feat/pdf file upload and extraction edge function example (#15580)
* feat: Feat/pdf file upload and extraction edge function example

* Added MDX file, slightly improvements on function code

* Added to the navbar, refactored into Deno.serve()

* Apply suggestions from code review

---------

Co-authored-by: Copple <10214025+kiwicopple@users.noreply.github.com>
Co-authored-by: Rodrigo Mansueli Nunes <rodrigo@mansueli.com>
Co-authored-by: Thor 雷神 Schaeff <5748289+thorwebdev@users.noreply.github.com>
2023-12-15 02:10:11 +08:00
wave-light 81e146f26b Update README.md (#19103)
Correct the example endpoint to `/oak-server/greet`
2023-11-26 22:08:36 -05:00
Thor 雷神 Schaeff 772c4ac119 docs: update scopes docs. (#19090)
* docs: update scopes docs.

* docs: backlink to oauth app creation docs.
2023-11-20 07:06:01 +00:00
Lakshan Perera 67367d7f4e chore: updated Edge Functions examples (#18742)
* Removed the use of deprecated std/http in favor of Deno.serve
* Use full import paths instead of using paths from import maps (less
  confusing, easy to copy examples)
* Formatted all examples with `deno fmt`
2023-11-06 19:55:22 +11:00
Rodrigo Martins Mansueli 0f5d1e9594 Feat add edge function slack mention example (#18237)
* feat edge slack mention

* docs: fix slack thread_ts property casing

---------

Co-authored-by: Greg Richardson <greg.nmr@gmail.com>
2023-10-17 15:13:51 -03:00
Greg Richardson c743800909 docs: update edge function url format 2023-09-19 15:34:41 -06:00