Build
Everything you need to build an application on backd: configuration, the HTTP API, authentication, organizations, functions, files, push and clients.
You write the application; backd serves it. This section covers every feature an application uses, in roughly the order you meet them:
| I want to… | Go to |
|---|---|
| Describe my data: schemas, indexes, realms | Configuration |
| Read, write and query documents over HTTP | HTTP API |
| Users, sessions, sign-in providers, API keys, access rules | Authentication |
| Group a customer’s users and documents | Organizations |
| Server-side logic: calls, jobs, cron, webhooks, email | Functions |
| Attachments, uploads, downloads, sharing | Files |
| Reach users’ devices | Push |
| Talk to it from JavaScript or Dart, or generate clients and types | Clients |
| See a complete application | Examples |
Running the service itself — deployment, providers, administration — lives in Operate.
From zero to a running realm in a few commands: get backd, generate a project from the template, and run its compose stack locally.
ConfigurationEnvironment variables that control backd at runtime.
HTTP APIRequest IDs, request bodies, errors and health endpoints.
AuthenticationUsers, sign-in methods and passwords in each realm.
OrganizationsOrganizations group the users of a customer and the documents that belong to them. The concepts: roles, membership, effective roles, claims, invitations and deletion.
FunctionsRun server-side logic next to your data: sync calls, background jobs, cron schedules and webhooks, with the rules, secrets and limits that keep them safe.
FilesLet documents carry files, kept in the realm’s own S3-compatible object storage: how a realm connects its storage, and what backd checks.
Push notificationsDevices, templates and sending: backd registers the devices of your users and sends their pushes itself.
ClientsLibraries for calling backd from applications.
ExamplesExample applications built on backd, and what each one shows.