Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting started

Download options for Linux x86_64 and aarch64 are on the releases page.

MethodCommand
Verified installerRun the one-liner below.
GitHub ReleaseDownload the matching tarball and SHA256SUMS from the latest release, verify with sha256sum -c SHA256SUMS, and install the extracted binary.
Dockerdocker compose up -d with compose.yaml. See Deployment for the volume.
Cargo Binstallcargo binstall monitra --manifest-path Cargo.toml from a checkout. Plain cargo binstall monitra awaits crates.io publication.
Build from sourcecargo build --release with Rust and Node/npm on PATH.
curl -fsSL https://raw.githubusercontent.com/rustiqz/monitra/main/scripts/install.sh | sh

Verify a binary install with monitra --version. The installer defaults to ~/.local/bin; use --dir PATH to change it. Ensure the chosen directory is on PATH.

Configuration is optional. On a pristine machine, add a monitor directly; this creates the default SQLite database under your XDG data directory.

monitra monitor add --name example --target https://example.com --kind http --interval 30
monitra monitor list
monitra start

On first daemon start, Monitra generates an API token, writes it to its XDG config, and prints it once. Save it. The daemon binds 127.0.0.1:8080 by default. In another terminal, use monitra tui for a terminal dashboard or monitra web for the embedded browser dashboard. Both can start their own local backend when no --url is supplied.

For optional configuration, run monitra setup or read Configuration. See Deployment before exposing the daemon remotely.