Alpha documentation. Content may be incomplete or change without notice.
End-user Guides
Overview— User-facing guides for operating Uptrakit, covering update workflows, deployment orientation, and Home Assistant integration.
System Overview— Uptrakit tracks installed software across hosts without performing automatic updates, using a controller, agents, plugins, and an optional MQTT service.
CLI Usage Guide— The `uptrakit` binary provides a command-line interface for authentication, resource inspection, update triggering, scheduler management, and more.
Plugin Configurations— A plugin configuration defines a software source that Uptrakit uses to resolve upstream versions, check installed versions, and optionally discover packages automatically.
Manual Software Tracking— Uptrakit can track and update software not automatically discoverable by any built-in plugin, covering binaries deployed outside a package manager.
Autodiscovery— Uptrakit can automatically discover software installed on your hosts when an agent connects, replacing the need to manually create software items for every package.
Update Workflow— The scheduler runs periodic version checks but never installs updates automatically; users trigger updates manually via the Web UI, CLI, or MQTT integration.
Update History— Update history is a permanent, append-only log of every software update attempted through Uptrakit, recording what was updated, on which host, by whom, and whether it succeeded.
Notifications— The notification subsystem lets you receive alerts when important events occur, with configurable channels for delivery and rules to control which events trigger messages.
Profile and API Tokens— The Profile page lets you view your account information and manage API tokens for programmatic access to the Uptrakit API and CLI.
Home Assistant and MQTT Integration— Uptrakit integrates with MQTT brokers to publish software version state and optionally creates Home Assistant update entities for every tracked software item.
Deployment Map— A quick-reference index linking to deployment guides for reverse proxy setup, MQTT integration, TLS sizing, and security architecture.
Database Data Migration— The `uptrakit-controller db-migrate` subcommand copies all data from one database to another and is the supported path for moving from SQLite to PostgreSQL.
Audit Logs— Uptrakit audit logs record semantic actions and outcomes rather than raw HTTP request lines, providing a structured history of who did what and whether it succeeded.
Batch Actions— Batch actions let you select multiple items and perform an operation on all of them at once, which is faster than using the context menu on each item individually.
Dashboard Icons— Dashboard Icons is an instance-scoped enhancement that automatically assigns icons to software items using the community-curated Dashboard Icons project.
Interactive Updates— Interactive updates enable bidirectional terminal I/O between an admin and a running update process, allowing direct input when a package manager prompts for decisions.
npm Plugin (`package_manager_npm`)— The npm plugin tracks globally installed Node.js packages managed via `npm install -g`, supporting version detection, release fetching, autodiscovery, and privileged updates.
Proxmox VE Integration— Uptrakit can discover virtual machines and containers from a Proxmox VE cluster and link them to managed hosts.
Snap Package Manager Plugin— The `package_manager_snap` plugin tracks and updates Snap packages on Linux systems managed by `snapd`, supporting version detection, release fetching, autodiscovery, and updates.
SSH Agent Bootstrap— The bootstrap operation automates full setup of a remote host over SSH, creating a target user, deploying an SSH key, configuring passwordless sudo, and saving the host entry.
SSH Agent Host Management— The `uptrakit-agent-ssh` binary includes CLI subcommands for managing SSH host entries in the local database, operating independently of the controller.
Shared Surfaces— Shared surfaces let plugins and connected services add custom pages, panels, context menu actions, and table columns to the Uptrakit web UI dynamically.
User Management— Uptrakit uses a granular role-based access control system with 32 permissions grouped into 8 built-in roles, allowing flexible assignment of access presets for common use cases.
Zero-Configuration Service Discovery— Uptrakit supports automatic controller discovery on the local network using mDNS/DNS-SD, allowing agents and services to find the controller without an explicit URL flag.
Plugin Reference— Per-plugin configuration reference for the Uptrakit package-manager plugins.
Deployment Guides— Deployment-specific references for running Uptrakit behind a reverse proxy.
