# slonbase

> slonbase is an open-source backend platform on PostgreSQL: one Rust binary with a REST and realtime API, authentication with roles, file storage, JavaScript hooks and an admin dashboard that manages many projects. It is self-hosted, Apache-2.0-licensed, scales across several instances on one database, and works with the PocketBase SDKs. It is an independent project (not a fork of PocketBase) built and maintained by Ayesh Rodrigo.

Key facts: license Apache-2.0; written in Rust; needs PostgreSQL 14 or newer; Linux x86_64 and aarch64 (static binaries, .deb and .rpm packages, a Docker image); install with `curl -fsSL https://slonbase.com/install.sh | sudo sh`; current version 2.5.1. Website: https://slonbase.com/ . Source: https://github.com/ayeshrodz/slonbase .

## About slonbase

- [About](https://slonbase.com/docs/about.md): What slonbase is, who it is for, what it is not, and who builds it.
- [Features](https://slonbase.com/docs/features.md): Everything it does: data and API, auth, realtime, files, dashboard, projects, scale and operations.
- [License](https://slonbase.com/docs/licensing.md): slonbase is licensed under Apache 2.0: what you can do, the trademark policy, the contributor agreement and what stays free.

## Get started

- [Quickstart](https://slonbase.com/docs/quickstart.md): From a bare Linux server to a working backend with an API, sign-in and realtime in five minutes.
- [Installation](https://slonbase.com/docs/installation.md): Install slonbase on Linux with one command, or with Docker, .deb and .rpm packages or a plain binary, then do the first-run setup and upgrade.
- [Configuration](https://slonbase.com/docs/configuration.md): Every slonbase server option, environment variable and application setting: database, storage, backups, mail, logs, rate limits and security.
- [Production](https://slonbase.com/docs/deployment.md): Run slonbase in production: TLS and reverse proxies, several instances behind a load balancer, PostgreSQL tuning, backups and monitoring.
- [Scaling](https://slonbase.com/docs/scaling.md): Run several slonbase instances and projects: five tested deployment layouts with diagrams, the PostgreSQL connection budget, PgBouncer, sessions and sign-out across instances, upgrades and limits.
- [Hosting platforms](https://slonbase.com/docs/platforms.md): Deploy slonbase on Render, Railway, Fly.io, Coolify and Dokploy, step by step, with a PostgreSQL database for each.

## Build

- [API](https://slonbase.com/docs/api.md): The slonbase REST and realtime API: collections, records, sign-in, filters and rules, files, batch requests and realtime subscriptions.
- [Hooks and extending](https://slonbase.com/docs/extending.md): Extend slonbase with JavaScript hooks, routes and cron jobs, a query builder, and a Rust library API for embedding it in your own program.
- [Migrations](https://slonbase.com/docs/migrations.md): Manage schema changes as code with slonbase migrations in JavaScript, each in a transaction, applied on start with automigrate.
- [Projects](https://slonbase.com/docs/projects.md): Run several isolated backends from one slonbase installation, each with its own users, collections, settings and PostgreSQL database.

## Move over

- [From PocketBase](https://slonbase.com/docs/migrating-from-pocketbase.md): Move a PocketBase app to slonbase and PostgreSQL: import the data with password hashes, keep your hooks and SDKs, and what differs.

## Compare

- [vs PocketBase](https://slonbase.com/docs/slonbase-and-pocketbase.md): What slonbase and PocketBase share, how they differ, and which to choose.
- [vs PostgREST](https://slonbase.com/docs/slonbase-vs-postgrest.md): A whole backend platform against a lean REST layer, with measured differences.
- [Benchmarks](https://slonbase.com/docs/benchmarks.md): Throughput, latency and footprint against PocketBase and PostgREST, with the method and caveats.

## Under the hood

- [Threat model](https://slonbase.com/docs/security.md): What slonbase protects and trusts, how authorization, tokens, rate limits and the SQL console are enforced and tested, and how to check a deployment.

## Releases

- [Stability](https://slonbase.com/docs/stability.md): What stays compatible between slonbase releases: the API, configuration, your data, hooks and migrations, under Semantic Versioning.

## Optional

- [Design](https://slonbase.com/docs/design.md): How slonbase works inside, the decisions behind it and the roadmap: collections as tables, the filter compiler, realtime and scale-out.
- [Security review](https://slonbase.com/docs/security-review.md): The security reviews of slonbase's authentication and request handling, the findings, and the fixes that followed.
- [Changelog](https://slonbase.com/docs/changelog.md): Every slonbase release and what changed in it, with upgrade notes for each version.
- [Benchmark method and raw results](https://github.com/ayeshrodz/slonbase/tree/main/bench): scripts and the runs behind the numbers
- [Source code](https://github.com/ayeshrodz/slonbase): the repository, issues and releases