Run a Relay Node

Help the Gratonite network by running a relay. Lightweight, requires minimal resources.

What is a Relay?

A relay routes encrypted messages between Gratonite instances that can't reach each other directly (e.g., servers behind NAT). The relay never reads message content. It only sees encrypted envelopes and forwards them.

Quick Start

cd apps/relay

cp .env.example .env

docker compose up -d

That's it. Your relay is running.

Requirements

1 vCPU

CPU

Minimal compute

256 MB

RAM

Redis + relay

10 Mbps

Bandwidth

Scales with usage

Reputation System

Every relay has a public reputation score (0-100).

UptimeKeep your relay online
30%
Delivery RateSuccessfully forward envelopes
30%
LatencyLower latency = higher score
20%
AgeTrust builds over time
10%
ReportsAvoid abuse reports
10%

Monitoring

Built-in health and Prometheus metrics endpoints:

# Health check

curl https://your-relay.com/health

# Prometheus metrics

curl https://your-relay.com/metrics

# Relay identity

curl https://your-relay.com/.well-known/gratonite-relay

Full Documentation

Advanced configuration, mesh setup, TURN proxy, and more.

View Full Docs →