Status: PurrOS is in early development and has no tagged release yet. The API server and
purrosCLI work today and cover every feature area; the web app is not built yet. Throughout these docs, anything marked (planned) isn't built, screens ("Settings → …") arrive with the web app, and each feature guide starts with a status note and ends with the endpoints you can use now. See api/README.md for the full list of what's implemented, and the roadmap.
PurrOS is an open-source, self-hosted operations platform (ERP) for businesses with 20–500 people. It covers people, scheduling, time, cash, inventory, ordering, sales, checklists, equipment, communication and reporting across one location or many. Every feature is optional, and other systems connect through a REST API.
| I want to… | Read |
|---|---|
| Install PurrOS on my own server | Installation |
| Set up email (SMTP) and file storage (S3) | Email & file storage |
| Look up an environment variable, or the config and state directories | Configuration |
| Set up my company after installing | First-run setup |
| Understand the words PurrOS uses | Key concepts |
| Connect my POS, online store or timeclock | Integrations |
| Use the API | API overview |
- Installation: requirements, Docker Compose, reverse proxy, first admin
- Deploying on Dokploy: the Dokploy Compose file, environment, domain and first-time setup
- Configuration: every environment variable, and the
config/andstate/directories - Email & file storage: SMTP, S3-compatible storage, backups to S3
- First-run setup: setting up with the CLI today, and the planned setup wizard
- Key concepts: the terms used throughout PurrOS
- Organization & locations: hierarchy, location profiles, inherited settings
- Users, roles & permissions: accounts, custom roles, reach, safeguards
- Permissions reference: every permission, grouped by feature
- Authentication: sign-in methods, SSO, 2FA, sessions
- Feature switches: turning features on and off, dependencies, data retention
| Guide | For |
|---|---|
| People & HR | HR, managers |
| Scheduling & forecasting | Managers, schedulers |
| Time & attendance | Managers, payroll |
| Cash management | Managers, finance |
| Inventory | Inventory and warehouse staff, managers |
| Purchasing & ordering | Purchasing, managers |
| Sales | Sales, fulfilment |
| Forms, checklists & compliance | Managers, auditors, all staff |
| Equipment & assets | Managers, maintenance |
| Communication | Everyone |
| Team displays | Managers |
| Reports & insights | Managers, owners |
| Employee Area | Every employee |
- API overview: authentication, scopes, conventions, errors, pagination, rate limits, versioning
- Endpoint index: every resource, grouped by feature
- Data ingestion: sending data from POS systems, online stores and other services
- Webhooks: event catalog, payloads, signature verification, retries
- Integrations overview: how integrations work, the manifest, registration
- Build an integration: step-by-step TypeScript tutorial
- Integration recipes: POS, online store, timeclock, HR, payroll, accounting, sensors
- Development guide: local setup, repository layout, adding a feature module, testing
- PRODUCT.md: vision, users, scope, non-goals, roadmap
- DESIGN.md: architecture, data model, API design, UI system