Documentation

Quickstart

Server installed, one host reporting, in about ten minutes. Every command here is explained in full on the pages that follow.

Before you start. You need a Linux host for the server with root access, and at least one machine to monitor. The server needs no internet connection at any point, including for licensing.

1. Install the server

sudo sh install-server.sh

This creates an unprivileged torwarden user, installs the binary to /usr/local/bin/torwarden-server, writes /etc/torwarden/server.conf with mode 0640, and enables a systemd unit. Confirm it:

torwarden-server check

Then open http://your-server:8080 and create the first administrator using the one-time setup link the server prints to its log on first start.

2. Register the host you want to monitor

In the dashboard, go to Hosts → Add host and enter its hostname. Torwarden gives you an API key, shown once. Copy it.

3. Install the agent on that host

sudo sh install-agent.sh \
  --url  https://torwarden.example.com \
  --key  twd_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Then prove it works from the machine itself, rather than by waiting to see whether it turns up:

torwarden-agent check
ok    configuration /etc/torwarden/agent.conf
ok    hostname web-01, reporting every 30s
ok    reached https://torwarden.example.com
ok    the API key is accepted

Start it:

sudo systemctl start torwarden-agent

4. Watch the first reading arrive

The host appears on the Hosts page within one collection interval — thirty seconds by default. Charts fill in as history accumulates.

Then what?

Install the server — configuration, HTTPS, backups, upgrades.
System requirements — what to size, and what actually limits capacity.
Install the agent — Linux and Windows, including unattended installs.
Using Torwarden — alert rules, endpoints, certificates, dashboards, availability.
CLI reference — every command on both binaries.