# HostBase

> HostBase is a Polish Supabase-compatible backend platform: every project gets its own Postgres 17, Auth, Storage, Realtime and Edge Functions, plus Workers (containers), Sites (frontend hosting), one-click Apps, transactional Email, an OpenAI-compatible AI Gateway and Feature Flags. Everything is controllable through a REST Management API, a CLI, an MCP server and typed SDKs.

## API
- [OpenAPI 3.1 document](https://host.ulewicz.space/api/v1/openapi.json): machine-readable Management API (all operations, schemas, required scopes)
- [API reference](https://host.ulewicz.space/en/docs/api): interactive reference, authentication, scoped tokens, OAuth 2.1
- [llms-full.txt](https://host.ulewicz.space/llms-full.txt): the whole API described in plain text for agents
- [Postman collection](https://host.ulewicz.space/docs/api/postman.json) and [Bruno collection](https://host.ulewicz.space/docs/api/bruno.json)
- [API changelog](https://host.ulewicz.space/en/docs/api-changelog)

## Tools for agents
- [MCP server](https://host.ulewicz.space/en/docs/mcp): https://host.ulewicz.space/api/mcp (Streamable HTTP; hb_pat_ token or OAuth 2.1 with PKCE)
- [CLI](https://host.ulewicz.space/en/docs/cli): `hostbase` (db push, functions deploy, gen types, config plan/apply, skills install, mcp install)
- TypeScript SDK `@hostbase/management` (sdk/management) and Python client `hostbase_management` (sdk/python)

## Quickstarts
- [Quickstart](https://host.ulewicz.space/en/docs/quickstart): Create a project, grab the keys and run your first query in under 5 minutes.
- [Quickstart: Database](https://host.ulewicz.space/en/docs/quickstart/database): Create a project, a table and your first query in a few minutes.
- [Quickstart: Auth](https://host.ulewicz.space/en/docs/quickstart/auth): Sign users up and in with supabase-js in 3 steps.
- [Quickstart: Storage](https://host.ulewicz.space/en/docs/quickstart/storage): A bucket, an upload and a signed URL.
- [Quickstart: Edge Functions](https://host.ulewicz.space/en/docs/quickstart/functions): Write, deploy and invoke a Deno function.
- [Quickstart: Workers](https://host.ulewicz.space/en/docs/quickstart/workers): Deploy a container from a gallery template and run a job.
- [Quickstart: Sites](https://host.ulewicz.space/en/docs/quickstart/sites): Deploy a frontend (static or SSR) next to your database.
- [Quickstart: One-click apps](https://host.ulewicz.space/en/docs/quickstart/apps): Install Metabase, Grafana, Umami and more, wired to your database.
- [Quickstart: Email](https://host.ulewicz.space/en/docs/quickstart/email): Add a sending domain and send your first message.
- [Quickstart: AI Gateway](https://host.ulewicz.space/en/docs/quickstart/ai-gateway): One OpenAI-compatible API with your provider keys, budgets and caching.
- [Quickstart: Sandboxes (coming soon)](https://host.ulewicz.space/en/docs/quickstart/sandboxes): Isolated environments for running untrusted code - placeholder for an upcoming product.

## Documentation
- [Next.js](https://host.ulewicz.space/en/docs/frameworks/nextjs): HostBase in a Next.js (App Router) app with server-side sessions.
- [React (Vite)](https://host.ulewicz.space/en/docs/frameworks/react): A React + Vite app with sign-in and database queries.
- [Flutter](https://host.ulewicz.space/en/docs/frameworks/flutter): Using HostBase from Flutter with supabase_flutter.
- [Database](https://host.ulewicz.space/en/docs/database): Postgres 17, extensions, direct connections and the PgBouncer pooler, auto-generated APIs.
- [Authentication](https://host.ulewicz.space/en/docs/auth): E-mail and password, magic links, OAuth, JWT sessions and RLS integration.
- [Storage](https://host.ulewicz.space/en/docs/storage): Buckets, uploads, signed URLs, the S3 protocol and file management in the dashboard.
- [Realtime](https://host.ulewicz.space/en/docs/realtime): Database changes, broadcast and presence over WebSockets.
- [Edge Functions](https://host.ulewicz.space/en/docs/edge-functions): Serverless TypeScript (Deno) functions hosted next to your database — deployed from the dashboard, API or MCP.
- [Vectors & AI](https://host.ulewicz.space/en/docs/vector): pgvector embeddings, semantic search and RAG.
- [MCP server](https://host.ulewicz.space/en/docs/mcp): Connect Claude, Cursor and other AI agents to HostBase through the Model Context Protocol.
- [Management API](https://host.ulewicz.space/en/docs/api): REST API for automation: organizations and projects, authenticated with a personal access token.
- [CLI](https://host.ulewicz.space/en/docs/cli): HostBase CLI: projects, migrations (db push), TypeScript types, Edge Functions, secrets, branches, backups and PITR from your terminal.
- [Migrating from Supabase](https://host.ulewicz.space/en/docs/migracja-z-supabase): Move a Supabase project to HostBase with pg_dump, pg_restore and two env vars.
- [Monitoring & notifications](https://host.ulewicz.space/en/docs/monitoring): Reports, logs, advisors, alerts and upgrade suggestions.
- [Backups](https://host.ulewicz.space/en/docs/backups): Daily and manual backups, off-site copies, restore and download.
- [Row Level Security](https://host.ulewicz.space/en/docs/security/rls): Protect data with Postgres policies and auth.uid().
- [Billing](https://host.ulewicz.space/en/docs/billing): Plans, limits, compute sizes and invoices.
- [Regions](https://host.ulewicz.space/en/docs/regions): Where your data physically lives.
- [Integrations](https://host.ulewicz.space/en/docs/integracje): Extend your database with Postgres modules, wrappers and HostBase add-ons.
- [Wrappers (FDW)](https://host.ulewicz.space/en/docs/integracje/wrappers): Query Stripe, Notion, S3 and more as Postgres tables.
- [Vault](https://host.ulewicz.space/en/docs/integracje/vault): Encrypted secrets inside your database.
- [Queues](https://host.ulewicz.space/en/docs/integracje/queues): Durable message queues in Postgres with pgmq.
- [GraphQL](https://host.ulewicz.space/en/docs/integracje/graphql): pg_graphql and the in-dashboard GraphiQL IDE.
- [Add-ons](https://host.ulewicz.space/en/docs/integracje/add-ony): Connection pooler (PgBouncer), cache (Valkey/Redis) and search (Meilisearch).
- [App connections](https://host.ulewicz.space/en/docs/integracje/polaczenia-aplikacji): Per-app API credentials, redirect URLs and secrets for connecting external apps.
- [Migrations](https://host.ulewicz.space/en/docs/migracje): Schema migrations compatible with the Supabase CLI.
- [Pipelines](https://host.ulewicz.space/en/docs/pipelines): Logical replication to external Postgres, Debezium and other subscribers.
- [API keys & JWT rotation](https://host.ulewicz.space/en/docs/klucze-api): anon and service_role keys, and rotating the JWT secret.
- [Data API](https://host.ulewicz.space/en/docs/data-api): PostgREST settings: exposed schemas, max rows and search path.
- [Log drains](https://host.ulewicz.space/en/docs/log-drains): Ship project logs to HTTP, Loki or Datadog.
- [Connect dialog](https://host.ulewicz.space/en/docs/panel/polacz): Ready-made snippets for frameworks, ORMs, the pooler and MCP.
- [Compute — instance size](https://host.ulewicz.space/en/docs/compute): Choosing a Postgres instance size, with recommendations based on usage.
- [Network restrictions (IP allowlist)](https://host.ulewicz.space/en/docs/network): Who can connect directly to the project's Postgres and pooler.
- [Sites - frontend hosting](https://host.ulewicz.space/en/docs/sites): Static sites and SSR apps next to your database: deployments, previews, rollback, domains, GitHub, hook and CLI.
- [Sites - automation and deploy pipelines](https://host.ulewicz.space/en/docs/sites-automation): Creation wizard, hostbase.json, pre/post-deploy steps, smoke tests, auto-rollback, schedules, Lighthouse, environment groups and scripts.
- [Sites - protection, rules, A/B, comments and migration](https://host.ulewicz.space/en/docs/sites-platform): Password/SSO for previews, maintenance mode, redirects and geo/A-B rules, skew protection, image and OG endpoints, comments, deploy freeze, import from Vercel/Netlify/Cloudflare and moving between regions.
- [Custom domains](https://host.ulewicz.space/en/docs/custom-domains): Your project's API on your own domain, with an automatic certificate.
- [Moving a project between regions](https://host.ulewicz.space/en/docs/move-project): Change region (Warsaw ↔ Stockholm) without changing URLs or keys.
- [Project templates](https://host.ulewicz.space/en/docs/templates): Ready-made backends: SaaS, blog, shop, AI chat with RAG, Realtime chat, to-do list.
- [Read replicas](https://host.ulewicz.space/en/docs/read-replicas): Read-only database copies kept in sync by streaming replication, in the same or another region.
- [Compute autoscaling](https://host.ulewicz.space/en/docs/autoscaling): Automatically resize the instance within set limits.
- [One-click import from Supabase](https://host.ulewicz.space/en/docs/import-z-supabase): A wizard that moves your database, Auth users and Storage files from Supabase to HostBase.
- [Postgres versions & upgrades](https://host.ulewicz.space/en/docs/wersje-postgresa): Patch upgrades, 15 → 17, hb1, maintenance windows, compatibility report, dry-run and rollback.
- [Point-in-time recovery](https://host.ulewicz.space/en/docs/pitr): Restore your database to any second within the retention window — continuous WAL archiving.
- [Database branching](https://host.ulewicz.space/en/docs/branching): Separate database environments for testing and previews — schema only or with data, migrations merged back to production.
- [Account security](https://host.ulewicz.space/en/docs/security/konto): MFA, sessions and the Trust Center.
- [Enterprise SSO (SAML 2.0 and OpenID Connect)](https://host.ulewicz.space/en/docs/sso): Sign in to the dashboard through your company identity provider: Okta, Entra ID, Google Workspace, Keycloak and others.
- [Keyboard shortcuts](https://host.ulewicz.space/en/docs/skroty-klawiszowe): Navigate the dashboard without a mouse.
- [GitHub integration](https://host.ulewicz.space/en/docs/github): A push deploys migrations and Edge Functions; a pull request creates a preview database branch.
- [Row change history](https://host.ulewicz.space/en/docs/baza/historia-zmian): Track INSERT/UPDATE/DELETE on selected tables — before and after values, who made the change, retention.
- [Index advisor](https://host.ulewicz.space/en/docs/baza/doradca-indeksow): index_advisor and HypoPG: index suggestions for slow queries, cost simulation and CONCURRENTLY builds.
- [Table partitioning (pg_partman)](https://host.ulewicz.space/en/docs/baza/partycjonowanie): Tables split by time or ID, partitions created ahead of time, retention via pg_cron.
- [Audit logging (pgaudit)](https://host.ulewicz.space/en/docs/baza/logowanie-audytu): Log SQL statements from selected classes (READ, WRITE, DDL, ROLE...) in the Postgres log.
- [Database tests (pgTAP)](https://host.ulewicz.space/en/docs/baza/testy): Schema, RLS policy and function tests in pgTAP - from the dashboard, CLI, API and on GitHub preview branches.
- [pg_repack and plpgsql_check](https://host.ulewicz.space/en/docs/baza/narzedzia-postgres): Reclaim space from dead rows without locking the table, and static analysis of PL/pgSQL functions.
- [Image transformations](https://host.ulewicz.space/en/docs/transformacje-obrazow): On-the-fly resizing, cropping and WebP/AVIF for Storage files - Supabase compatible.
- [Polish full-text search](https://host.ulewicz.space/en/docs/polskie-wyszukiwanie): sjp.pl dictionary for Postgres FTS: inflection, stop words, accent-insensitive variant, tsvector column with a GIN index.
- [API limits (rate limiting)](https://host.ulewicz.space/en/docs/limity-api): Per-IP or global request limits for REST, Auth, Storage and Edge Functions - HTTP 429 at the API gateway.
- [WAF, bot protection and static egress IP](https://host.ulewicz.space/en/docs/waf): OWASP CRS firewall (Coraza), custom rules, sign-in bot protection with automatic bans and a dedicated static egress IP.
- [database.dev packages](https://host.ulewicz.space/en/docs/database-dev): Install SQL extensions from the database.dev registry via pg_tle - browse, versions, uninstall.
- [Workflows with pgflow](https://host.ulewicz.space/en/docs/pgflow): Workflow engine on Postgres and Edge Functions: installation, worker, running and inspecting runs.
- [Supabase Studio, Stripe Sync Engine and ElectricSQL](https://host.ulewicz.space/en/docs/addony-studio-stripe-electric): HostBase add-ons: the original Studio, Stripe-to-Postgres sync and ElectricSQL shapes.
- [1-click apps: Metabase, Grafana, Umami, Windmill and more](https://host.ulewicz.space/en/docs/aplikacje-1-klik): Auto-installers connected to the project database: licenses, database roles, credentials, versions, billing, API, MCP and CLI.
- [Table editor: PostGIS map, JSON validation and test data](https://host.ulewicz.space/en/docs/edytor-narzedzia): Map for geometry/geography columns, JSON Schema constraints (pg_jsonschema) and a realistic data generator.
- [Type generation: TypeScript, Zod, Kysely](https://host.ulewicz.space/en/docs/typy): Types generated live from the database schema - in the dashboard, via API and CLI.
- [Workers](https://host.ulewicz.space/en/docs/workers): Heavy and long-running jobs in 19 runtimes with auto-detection, system packages and a gallery of ready-to-deploy templates.
- [Sandboxes](https://host.ulewicz.space/en/docs/sandboxes): Isolated microVM environments for running code from AI agents: exec, files, a Python kernel, port previews, SDK, MCP and the AI Gateway.
- [AI Gateway](https://host.ulewicz.space/en/docs/ai-gateway): OpenAI-compatible gateway for Claude, GPT and Mistral on your own keys: keys, limits, cache, PII, logs and pgvector embeddings.
- [Observability: Issues, monitors and OTLP](https://host.ulewicz.space/en/docs/obserwowalnosc): Error grouping from Functions and Workers, live health advisors, HTTP monitors with SLOs, OpenTelemetry export and index recommendations.
- [Costs, credits and limits](https://host.ulewicz.space/en/docs/billing-finops): Cost explorer with forecast, prepaid credits (single-purpose voucher), spend limits, referral programme and active-CPU metering.
- [AI agents, config-as-code and Feature Flags](https://host.ulewicz.space/en/docs/agenci-dx): hostbase init/skills/mcp install for Claude Code, Cursor and Codex, MCP with OAuth 2.1, inspect db, diff, hostbase.config.ts, OpenFeature Feature Flags and a Terraform provider.
- [Workers](https://host.ulewicz.space/en/docs/workers): Heavy and long-running jobs in 19 runtimes with auto-detection, system packages and a gallery of ready-to-deploy templates.
- [Access & security](https://host.ulewicz.space/en/docs/dostep-i-bezpieczenstwo): Scoped tokens, per-project roles, SCIM 2.0 and org policies: IP allowlist, session age and enforced MFA.
- [API changelog](https://host.ulewicz.space/en/docs/api-changelog): Management API and agent contract versions - what changed and when.

## Optional
- [Pricing](https://host.ulewicz.space/en/pricing)
- [Status](https://host.ulewicz.space/en/status)