Home

Warracker Wiki

Welcome to the Warracker wiki.

Warracker is an open-source, self-hosted warranty tracker. It lets individuals and teams organize product warranties, monitor expiration dates, and store receipts, invoices, manuals, and other documents in one place. You own the data.

Key features

• Centralized warranty management with purchase dates, durations, notes, and product photos
• Expiration monitoring with proactive alerts via email or Apprise (Discord, Slack, and 100+ other services)
• Document storage, local or via Paperless-ngx integration
• Warranty claims with statuses, dates, resolutions, and attached documents
• Status dashboard with charts, statistics, Total Value, and CSV export
• Tags, archiving, void status, multi-user support, global warranty view, and OIDC single sign-on
• CSV import and export covering every field, so a re-import restores data exactly
• 20 interface languages

What's in this wiki

• Getting Started — install with Docker Compose, Unraid, Proxmox, or TrueNAS, and the first-run checklist.
• User Guide — the full tour: every button on the dashboard, every field of the add/edit forms, cards, filters, views, tags, archiving, void status, claims, the status dashboard, and CSV import/export — with screenshots and tutorial GIFs.
• Authentication — local accounts, OIDC single sign-on, roles, and the global view.
• Notifications — email and Apprise alerts, thresholds, and the notify-once rule.
• Paperless-ngx — setup, the document browser, and per-user access rules.
• Settings — every setting explained: your preferences and notifications, plus the admin-only sections (site settings, OIDC, Paperless-ngx, site Apprise, audit trail, ownership transfer, user management).
• FAQ — the questions every new user asks, answered in one place.
• Troubleshooting — when something breaks: login and OIDC problems, missing notifications, empty Paperless browse, failed uploads, stale pages after an update.
• Configuration — every environment variable, what it does, and its default, plus how the container fits together.
• Backup and Restore — what to back up (database, uploads, .env), how to automate it, and how to restore.
• Updating — how to update, which image tag to use, and how to roll back safely.
• Reverse Proxy — Nginx, Caddy, Traefik, and Cloudflare Tunnel examples for serving Warracker on your own domain with HTTPS.
• Security — HTTPS, secrets, closing registration, Global View trade-offs, and how to report a vulnerability.
• Contributing — how to contribute code and translations, and how to set up a development environment.
• Roadmap — what is planned next: the 1.0.5 features, planned work, and the feature requests under consideration.
• Proxmox — install with the community helper script: one command creates an LXC and installs Warracker in it, no Docker required.
• TrueNAS — install from the official TrueNAS Apps catalog, or as a Custom App with the compose file.
• Unraid — install from Community Apps (Tools > System), straight from the catalog listing.

Getting started

The fastest way to run Warracker is Docker Compose. See the Setup section of the README and the docker-compose.yml in the repository. Warracker requires a PostgreSQL database: install a PostgreSQL container first, create a database and user, then point DB_HOST, DB_NAME, DB_USER, and DB_PASSWORD at it.

Unraid users can install Warracker from Community Apps (Tools > System), where the listing points at ghcr.io/sassanix/warracker/main:latest.

Links

• Repository
• README
• Releases
• Changelog
• Issue tracker
• Security advisories

Screenshots

The warranty list, with search, filters, and days-remaining on each card:

The status dashboard:

About this wiki

This wiki is maintained alongside the repository. The README is the quick overview; this wiki holds the full reference — setup, configuration, usage, and the roadmap. Corrections and additions are welcome.

Icons on this wiki are Font Awesome Free (CC BY 4.0), matching the icons used in the application itself.