FFDB documentation

Start with the right FFDB path

This documentation maps the released FFDB server, SDK packages, security boundaries, and operator workflows.

Starting here prevents a deployment choice, credential type, or local-replica design from being mistaken for a supported product guarantee.

Use it before installing FFDB or when deciding which guide owns the next task.

Requirements for FFDB documentation

• Prerequisite — A workload that needs self-hosted auth, scoped SQL, storage, or offline sync.
• Prerequisite — An operator who can own PostgreSQL, S3-compatible storage, email, TLS, and backups.
• Required value — The intended installation shape: packaged Docker release or packaged native components.
• Required value — The application runtime: browser, React, React Native, Node, or direct HTTP.

What FFDB is

FFDB is a self-hostable data platform. PostgreSQL stores organizations, projects, credentials, jobs, and other control-plane state. Application rows live in a dedicated SQLite database for each project and are only reached through constrained workers.

The public surface includes authentication, parameterized SQL, PostgreSQL-style row-level policies, logical offline sync, RLS-protected S3-compatible storage, a TypeScript SDK, a CLI, and a management portal.

Choose a path

• Install a verified release bundle, then use the portal and packaged CLI to create a project.
• Install the version-matched @ffdb/client SDK package in an existing browser or Node application.
• Add the @ffdb/react, @ffdb/react-native, or @ffdb/sync-client SDK package when the runtime needs that integration.
• Read the production security and backup guides before exposing a deployment to untrusted traffic.

FFDB documentation workflow

• 1. Choose the packaged installation route and bring the service to ready.
• 2. Create an organization and project, then separate platform credentials from end-user sessions.
• 3. Add the matching SDK packages and issue one parameterized, RLS-scoped query.
• 4. Finish with backup, observability, and production-security checks.

Verify ffdb documentation

You can name the supported installation, request path, credential boundary, and next task from the public release contract.

Troubleshoot ffdb documentation

• Server and package versions differ — select one announced release version and pin every component to it.
• Billing behavior is unclear — check the instance mode in Global admin: private/team retain analytics without charges, while BYO/Connect enable the operator-owned Free, PAYG, and Pro contract.

Continue from FFDB documentation

• Follow Quickstart for the shortest packaged path.
• Compare installation shapes in Deployment overview.