Documentation

Get up and running with Rivana in under 10 minutes

Overview

Rivana consists of two components:

Aggregator — The central server that receives data from collectors, stores metrics, and hosts the web dashboard.
Collector — A lightweight agent deployed on each host with storage devices to monitor.

The aggregator serves the dashboard and provides an installation script that automatically downloads and configures collectors on your hosts.

Deploy the Aggregator

Using the link we sent you, download the aggregator binary for your platform and run it. The aggregator is a single self-contained executable with no external dependencies.

Download

Download the appropriate binary for your server:

rivana-aggregator-linux-x64 — Linux x86_64
rivana-aggregator-linux-arm64 — Linux ARM64

Run

                # Make executable and run
chmod +x rivana-aggregator-linux-x64
./rivana-aggregator-linux-x64
            

On first run, the aggregator initializes its SQLite database and starts listening on port 9090 by default. Use --port to specify a different port:

                # Run on a custom port
./rivana-aggregator-linux-x64 --port 8080
            

Tip: For production deployments, configure the aggregator as a systemd service and place it behind a reverse proxy with TLS.

Activate Your License

Open your browser and navigate to the aggregator's address (e.g., http://your-server:9090).

On the Settings page (click 'Settings' in the top navbar), upload your license file. This can be either a trial license or a purchased license.

Deploy Collectors

The aggregator provides an installation script that automatically downloads the correct collector binary, creates the configuration, and sets up a systemd service.

One-Line Install

Run this command on each host you want to monitor (replace your-aggregator with your aggregator's address):

curl -fsSL http://your-aggregator:9090/install | sudo bash

The installer will:

Detect your platform (Linux x64/ARM64, macOS)
Download the collector binary to /usr/local/bin/
Create configuration at /etc/rivana/config.toml
Create a dedicated rivana user (not root)
Set up udev rules for secure device access
Install and start a systemd service

Verify Installation

                # Check service status
sudo systemctl status rivana-collector

# View logs
sudo journalctl -u rivana-collector -f
            

Within seconds, your devices will appear in the Rivana dashboard.

Managing Collectors

Service Commands

                # Stop the collector
sudo systemctl stop rivana-collector

# Start the collector
sudo systemctl start rivana-collector

# Restart the collector
sudo systemctl restart rivana-collector

# View logs
sudo journalctl -u rivana-collector -f
            

Uninstall

To remove a collector from a host:

curl -fsSL http://your-aggregator:9090/uninstall | sudo bash

Configuration

The collector configuration is stored at /etc/rivana/config.toml:

                # /etc/rivana/config.toml
[collector]
id = "hostname"
hostname = "hostname"

[aggregator]
url = "http://your-aggregator:9090"
            

Need Help?

If you run into any issues or have questions, we're here to help.

Contact Support