# PocketBase

PocketBase is an open-source backend in a single file that bundles an embedded SQLite database with realtime subscriptions, built-in file and user management, an admin dashboard, and a simple REST-ish API, for building. It is open source and self-hosted, installable on ZimaOS, Umbrel, Proxmox, Kubernetes (Helm) and Unraid.

Canonical page: https://ourlocalhost.com/app/1392/pocketbase

## Description

PocketBase is an open-source backend in a single file that bundles an embedded SQLite database with realtime subscriptions, built-in file and user management, an admin dashboard, and a simple REST-ish API, for building SaaS and mobile apps.

## Platform availability

Available on 6 of 10 platforms: Unraid, Umbrel, ZimaOS, Proxmox, Helm, Any server.

## Health score

97/100 (Excellent), based on 4 of 4 factors.
- Maintained: 96 (last commit 70 days ago)
- Popular: 96 (61,192 GitHub stars)
- Easy to install: 100 (6 install platforms, install notes, setup guide, Docker image)
- Light to run: 100 (64 MB minimum RAM, runs on ARM)

## Links

- Documentation: https://pocketbase.io/docs/
- ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/PocketBase
- Umbrel: https://apps.umbrel.com/app/pocketbase
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=pocketbase
- GitHub: https://github.com/pocketbase/pocketbase
- Kubernetes (Helm): https://artifacthub.io/packages/helm/techwolf12/pocketbase
- Official website: https://pocketbase.io/
- Unraid: https://ca.unraid.net/apps/pocketbase-0oyh0hw1jdkbtc?q=pocketbase

## Common questions

### How do I run PocketBase as a standalone backend?

Download the prebuilt executable for your platform, extract it, and run ./pocketbase serve in the extracted directory.

### Which port does the PocketBase admin dashboard use?

The Superuser admin UI is served on port 8090. Make sure that port is reachable from your browser.

### How should I expose PocketBase on a real domain?

Start PocketBase with your domain passed to the serve command. This helps the server use the correct host name and reduces manual hosts setup.

### Can I build PocketBase as a custom Go application?

Yes, PocketBase can be used as a Go library so you can add custom business logic. Initialize a Go module, add your code, and build a static executable with CGO_ENABLED=0.

### Does PocketBase guarantee backward compatibility between updates?

No, full backward compatibility is not guaranteed before v1.0.0. Production-critical use may require reading the changelog and applying manual migration steps from time to time.

## Alternatives

- Convex Database
- Directus: An Instant App & API for your SQL Database.
- Firebase: Firebase, provided by Google, is a backend service and application development platform.
- Hasura: Hasura is an open-source data access platform that turns a PostgreSQL database into a fast, secure, fully-typed GraphQL API for building mo…
- Supabase: The open source Firebase alternative.
- SurrealDB: SurrealDB is a modern "all-in-one" database that stores and organises your app's information.
- TrailBase: TrailBase is an open-source, self-hosted backend-as-a-service (BaaS) and open Firebase alternative that runs as a single executable built o…
- appwrite: Appwrite is an open-source, self-hosted backend platform for developers to add authentication, databases, storage, functions, messaging, re…

---
Source: Our Local Host (https://ourlocalhost.com/app/1392/pocketbase), the self-hosted and open-source app directory.
