Platform overview
Install, configure and operate PurrOS on your own server, and administer its organization, accounts, roles and features.
PurrOS is self-hosted: you run it on your own server or cloud account, and your data never leaves it unless you connect something. It runs as a single Go binary, purros, next to PostgreSQL, and the same binary is the admin CLI.
Getting started
Installation
Requirements, Docker Compose, reverse proxy and the first Owner.
Deploying on Dokploy
The Dokploy Compose file, environment, domain and first-time setup.
Configuration
Every environment variable, and the config/ and state/ directories.
Email & file storage
SMTP, S3-compatible storage and backups to S3.
First-run setup
Setting up with the CLI today, and the planned setup wizard.
Key concepts
The terms used throughout PurrOS.
Administration
Organization & locations
Hierarchy, location profiles, departments and inherited settings.
Users, roles & permissions
Accounts, custom roles, reach and safeguards.
Permissions reference
Every permission, grouped by feature.
Authentication
Sign-in methods, SSO, 2FA, sessions and API keys.
Feature switches
Turning features on and off, dependencies and data retention.
Operations
Backups & upgrades
Built-in consistent backups, restores and safe upgrades.
Monitoring & troubleshooting
Health checks, logs, purros doctor and common problems.
Security
What PurrOS protects, and what you are responsible for.
CLI reference
Every purros command.
Contributing
Want to work on PurrOS itself? The development guide covers local setup, the repository layout, the rules every endpoint follows, and adding a feature module.