Welcome to Postbase Documentation

An overview of Postbase — what it is, how the monorepo is structured, and how to run it locally.

Host your own Postbase instance — one-click deploys for Railway, DigitalOcean, Render, Fly.io, AWS, Google Cloud, Azure, Oracle Cloud, or plain Docker.

• Railway
• DigitalOcean
• Render
• Fly.io
• AWS
• Google Cloud
• Azure
• Oracle Cloud
• Docker (Self-Hosted)

Overview of Postbase authentication — dashboard auth, API keys, JWT, and the full SDK Auth API.

• Sign Up
• Sign In
• Magic Link (OTP)
• Get & Update User
• Sign Out
• Admin: Manage Users
• OAuth (Browser, Native & ID Token)
• Sessions & Remember Me

Query your project's PostgreSQL tables using the Postbase database query API and SDK.

• SDK Query Builder
• Row Level Security (RLS)
• Filters, Joins & Raw SQL
• Insert, Update, Upsert & Pagination

Upload, download, list, and manage files using the Postbase Storage API and SDK.

• Signed URLs, Move, Copy & Buckets

Call PostgreSQL functions in your project schema directly via the Postbase RPC API.

Send transactional email through your project’s configured provider (e.g. AWS SES).

Complete reference for the postbasejs client SDK — installation, client setup, and all available methods.

• Server-Side Rendering (SSR)
• Auth Methods
• Storage Methods
• TypeScript

All environment variables required to run a Postbase instance.

How Postbase organises its internal tables in the _postbase schema and isolates per-project data.