tyto/docs/getting-started.md

Getting Started

This guide will help you get Tyto running in minutes.

Prerequisites

• Docker and Docker Compose (v2.0+)
• Linux host (for monitoring)
• Modern web browser

Installation Methods

Method 1: Docker Compose (Recommended)

The quickest way to get started:

# Clone the repository
git clone https://somegit.dev/vikingowl/tyto.git
cd tyto

# Start the containers
docker compose up -d

Access the dashboard at http://localhost:3000

Method 2: One-Line Install

For a native installation on Linux:

curl -fsSL https://somegit.dev/vikingowl/tyto/raw/branch/main/scripts/install.sh | sudo bash

This will:

• Download the Tyto binary
• Create a system user (tyto)
• Set up configuration in /etc/tyto/
• Install and start a systemd service

Method 3: Manual Binary

Download the binary for your platform:

# Download latest release
curl -LO https://somegit.dev/vikingowl/tyto/releases/latest/download/tyto-linux-amd64.tar.gz

# Extract
tar -xzf tyto-linux-amd64.tar.gz

# Run
./tyto

First Run

1. Access the Dashboard

Open your browser to:

• Docker: http://localhost:3000
• Native: http://localhost:8080

2. Explore the Interface

The dashboard shows real-time metrics:

Card	Information
System	Hostname, kernel, uptime
CPU	Per-core usage, load averages
Memory	RAM, swap, buffers
Disk	Mount points, I/O rates
Network	Interfaces, bandwidth
Processes	Top consumers, process control

3. Configure Alerts

1. Click the Alerts card
2. Click Configure Thresholds
3. Set warning (e.g., 80%) and critical (e.g., 95%) levels
4. Enable Desktop Notifications for browser alerts

4. Adjust Refresh Rate

Use the R key or the dropdown in the header to change how often metrics update:

• 1 second (high detail)
• 5 seconds (default)
• 10 seconds (low bandwidth)
• 30 seconds (minimal)

Choosing Your Mode

Tyto supports three operational modes:

Standalone Mode (Default)

Single-host monitoring. No database required.

docker compose up -d
# or
TYTO_MODE=standalone tyto

Best for: Personal servers, development machines, single hosts.

Server Mode

Central server for multi-device monitoring. Requires database.

TYTO_MODE=server docker compose up -d

Best for: Multiple servers, teams, enterprise monitoring.

See Multi-Device Setup for details.

Agent Mode

Lightweight agent that reports to a central server.

TYTO_MODE=agent tyto

Best for: Monitored hosts in a multi-device setup.

Verifying Installation

Check Services

Docker:

docker compose ps
# Should show frontend and backend as "running"

Systemd:

systemctl status tyto
# Should show "active (running)"

Check Logs

Docker:

docker compose logs -f backend

Systemd:

journalctl -u tyto -f

Test API

curl http://localhost:8080/health
# Should return: {"status":"ok"}

Next Steps

• Usage Guide - Learn all dashboard features
• Configuration - Customize your setup
• Multi-Device Setup - Monitor multiple hosts
• Security - Set up authentication

Uninstalling

Docker

docker compose down -v  # -v removes volumes

Native Install

sudo systemctl stop tyto
sudo systemctl disable tyto
sudo rm /etc/systemd/system/tyto.service
sudo rm -rf /opt/tyto /var/lib/tyto /etc/tyto
sudo userdel tyto