Docs

Everything to run OpenFault, from the first container to your agents. Start with install โ†’

REST API
Every /api/v1 route with method, auth, parameters and response shape.
Backups
Daily S3-compatible backups (Cloudflare R2, AWS S3, MinIO), the CLI and how to restore.
iOS dSYMs
Upload dSYMs from an Xcode build phase so native iOS and macOS crashes resolve to Swift function, file and line.
Email
SMTP settings, the Amazon SES preset, test emails, the send log and what OpenFault emails about.
Send your first event
Point an existing Sentry SDK at OpenFault. Only the DSN changes.
Install
Run OpenFault with Docker, finish setup in the browser or with the setup token, put it behind HTTPS, upgrade and back it up.
Issues & grouping
How events become issues, custom fingerprints, in-app rules, retention, resolve, mute and regressions.
Live & TV mode
The live-update stream, the summary endpoint and the TV dashboard.
MCP server
Connect Claude Code, Cursor or any MCP client over HTTP to OpenFault, the free MIT self-hosted error tracker. Setup token onboarding, the 16 tools, the approval gate and token scopes.
Notifications
Email, Slack, Discord, Mattermost, Teams, Telegram and signed generic webhooks, per-user preferences and the spike rule.
Push & iOS app
Hosted or self-run push relay, QR pairing and widgets for the OpenFault iOS app.
Security
What OpenFault scrubs and stores, SSRF protections, rate limits, and how to report a vulnerability.
Source maps
Upload source maps with sentry-cli or the Sentry bundler plugins so minified JS frames resolve to file and line.
Teams & access
Roles, invites, project membership and API tokens.

Keyboard shortcuts

c
Copy the install command
t
Toggle theme
g d
Open the docs
?
Show this list