Deployment Guide

1. Install

Download the archive for your platform from the releases page, unpack it, and place the relaykit binary somewhere on your PATH, for example /usr/local/bin.

2. Create a data directory

$ sudo mkdir -p /var/lib/relaykit
$ sudo chown relaykit:relaykit /var/lib/relaykit

3. Run the service

RelayKit is usually run under systemd. A minimal unit looks like this:

[Service]
ExecStart=/usr/local/bin/relaykit serve --listen 127.0.0.1:7310 --data /var/lib/relaykit
Restart=on-failure
User=relaykit

4. Reverse proxy and TLS

RelayKit itself speaks plain HTTP on loopback. Terminate TLS in your reverse proxy (Caddy, nginx, or HAProxy) and forward traffic to 127.0.0.1:7310. Remember to raise the proxy's maximum request body size if you plan to relay large files; 2 GB is a common setting.

5. Housekeeping

Expired objects are removed by a built-in sweeper that runs every hour. To reclaim space immediately, run relaykit gc.