Getting Started

RIVO Server is a backend platform for IoT robot fleet management. It provides a robust, high-performance Go-based backend to manage your robot fleet efficiently.

Note: This guide is for operators, DevOps engineers, and integration developers. It covers deployment, configuration, and API usage.

1. Introduction

RIVO Server provides:

Robot Registration & Monitoring - Track status and monitor health.
Real-time Telemetry - Stream robot telemetry data (odometry, battery, sensors).
Log Management - Collect and stream logs from robots in real-time.
Alert System - Receive, acknowledge, and resolve robot alerts.
Map Management - Upload and manage ROS maps with trajectory tracking.
Command & Control - Send commands to robots via REST or WebSocket.

2. Package Contents

The release package contains the following structure:

release/
├── rivo-server          # Main server executable
├── rivo-admin           # Admin CLI tool
├── config.yaml          # Configuration file
├── custom_msg/          # Custom message schemas
├── data/                # SQLite database (if used)
└── logs/                # Server log files

3. First-Time Setup

Step 1: Install

Docker (recommended): Extract the Docker release package and run the installer:

unzip rivo-server-docker-<version>.zip
cd rivo-server-docker-<version>
./install.sh

The installer auto-generates secrets, creates .env, and starts Docker containers. Admin credentials are printed on completion.

Binary (systemd): Extract the binary release package and run the installer as root:

unzip rivo-server-linux-amd64-<version>.zip
cd rivo-server-linux-amd64-<version>
sudo ./install.sh

The installer installs to /opt/rivo-server/, injects JWT secrets into config.yaml, and enables a systemd service.

Step 2: Verify Status

Check if the server is healthy:

curl http://localhost:8080/health

Step 3: Default Credentials & Managing Users

The installer prints the default admin credentials on completion. Use rivo-admin to add users or change passwords:

# Interactive mode
./rivo-admin

# Common commands:
#   user add -u <email> -p <password> -l master
#   user reset-password -u <email> -p <newpass>
#   user list