* rebase and house keeping * fix: storage reference accuracy after docs review Fix RLS permission mappings, CDN cache behavior, file management limits, image transform descriptions, and S3 upload API signatures based on official Supabase documentation audit. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix offset * fix move and copy instructions --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
4.4 KiB
name, description, license, metadata
| name | description | license | metadata | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| supabase | Guides and best practices for working with Supabase. Covers getting started, Auth, Database, Storage, Edge Functions, Realtime, supabase-js SDK, CLI, and MCP integration. Use for any Supabase-related questions. | MIT |
|
Supabase
Supabase is an open source Firebase alternative that provides a Postgres database, authentication, instant APIs, edge functions, realtime subscriptions, and storage. It's fully compatible with Postgres and provides several language sdks, including supabase-js and supabase-py.
Overview of Resources
Reference the appropriate resource file based on the user's needs:
Database
| Area | Resource | When to Use |
|---|---|---|
| RLS Security | references/db-rls-*.md |
Row Level Security policies, common mistakes |
| Connection Pooling | references/db-conn-pooling.md |
Transaction vs Session mode, port 6543 vs 5432 |
| Schema Design | references/db-schema-*.md |
auth.users FKs, timestamps, JSONB, extensions |
| Migrations | references/db-migrations-*.md |
CLI workflows, idempotent patterns, db diff |
| Performance | references/db-perf-*.md |
Indexes (BRIN, GIN), query optimization |
| Security | references/db-security-*.md |
Service role key, security_definer functions |
Realtime
| Area | Resource | When to Use |
|---|---|---|
| Channel Setup | references/realtime-setup-*.md |
Creating channels, naming conventions, auth |
| Broadcast | references/realtime-broadcast-*.md |
Client messaging, database-triggered broadcasts |
| Presence | references/realtime-presence-*.md |
User online status, shared state tracking |
| Postgres Changes | references/realtime-postgres-*.md |
Database change listeners (prefer Broadcast) |
| Patterns | references/realtime-patterns-*.md |
Cleanup, error handling, React integration |
Storage
| Area | Resource | When to Use |
|---|---|---|
| Access Control | references/storage-access-control.md |
Bucket policies, RLS for storage |
| Standard Upload | references/storage-upload-standard.md |
File uploads up to 5GB |
| Resumable Upload | references/storage-upload-resumable.md |
Large file uploads with TUS protocol |
| Downloads | references/storage-download-urls.md |
Public URLs, signed URLs, download methods |
| Transformations | references/storage-transform-images.md |
Image resize, crop, format conversion |
| CDN & Caching | references/storage-cdn-caching.md |
Cache control, Smart CDN, stale content |
| File Operations | references/storage-ops-file-management.md |
Move, copy, delete, list files |
CLI Usage: Always use npx supabase instead of supabase for version consistency across team members.
Supabase Documentation
Everytime something is not clear, or you want to double-check something, reference the official Supabase documentation. It is the source of truth for all things Supabase and is regularly updated with the latest information, best practices, and examples. - Supabase Documentation. The documentation is available in html format on the website, but you can also fetch plain text versions of specific sections using the following endpoints:
Documentation:
# Index of all available docs
curl https://supabase.com/llms.txt
# Fetch all guides as plain text
curl https://supabase.com/llms/guides.txt
# Fetch JavaScript SDK reference
curl https://supabase.com/llms/js.txt