Overview
End-user Documentation
This folder contains user-facing guides for operating Uptrakit, including update workflows, deployment orientation, and Home Assistant integration.
Contents
| Document | Description |
|---|---|
| System Overview | High-level architecture and operational model for controller, agents, and plugins. |
| CLI Usage Guide | Command reference for the uptrakit binary (all command groups with examples). |
| Plugin Configurations | Managing plugin configs, supported plugin types, and autodiscovery. |
| Manual Software Tracking | Setting up tracking for software that cannot be autodiscovered (e.g. standalone binaries from GitHub releases). |
| Autodiscovery | How autodiscovery works, reviewing pending items, and the ignore list. |
| Update Workflow | Manual update process, scheduling behavior, and history/reporting expectations. |
| Update History | Viewing update history, status reference, and triggering updates from the web UI. |
| Notifications | Notification channels, rules, event types, and delivery log. |
| Profile and API Tokens | Account info, API token lifecycle, and security best practices. |
| Home Assistant and MQTT | MQTT setup and Home Assistant update entity integration. |
| Deployment Map | Navigation guide for deployment-related docs and configuration entry points. |
| Deployment Guides | Deployment-specific references, including reverse proxy setup guidance. |
| Docker Deployment | Docker Compose deployment with auto-enrollment and profiles. |
| Database Data Migration | Moving data from SQLite to PostgreSQL using uptrakit-controller db-migrate. |
Related Documentation
- Top-level docs catalogue:
docs/README.md - API and protocol behavior:
docs/api/README.md - Security controls and hardening:
docs/security/README.md - Contributor/developer setup:
docs/development/README.md