Download FlatRun - Installation Guide

Download Agent

The FlatRun Agent is the core backend service that manages your Docker deployments.

Available for Linux & macOS (amd64, arm64)

Linux

VERSION=$(curl -s https://api.github.com/repos/flatrun/agent/releases/latest | grep '"tag_name"' | cut -d'"' -f4 | tr -d 'v')
curl -LO https://github.com/flatrun/agent/releases/download/v$VERSION/flatrun-agent-$VERSION-linux-amd64.tar.gz
tar -xzf flatrun-agent-$VERSION-linux-amd64.tar.gz
sudo mv flatrun-agent /usr/local/bin/

macOS

VERSION=$(curl -s https://api.github.com/repos/flatrun/agent/releases/latest | grep '"tag_name"' | cut -d'"' -f4 | tr -d 'v')
curl -LO https://github.com/flatrun/agent/releases/download/v$VERSION/flatrun-agent-$VERSION-darwin-arm64.tar.gz
tar -xzf flatrun-agent-$VERSION-darwin-arm64.tar.gz
sudo mv flatrun-agent /usr/local/bin/

Use linux-arm64 for ARM Linux or darwin-amd64 for Intel Macs.

Run as Service

Set up FlatRun Agent as a systemd service for automatic startup.

systemd

sudo tee /etc/systemd/system/flatrun-agent.service > /dev/null <<EOF
[Unit]
Description=FlatRun Deployment Agent
After=network.target docker.service
Requires=docker.service

[Service]
Type=simple
ExecStart=/usr/local/bin/flatrun-agent --config /etc/flatrun/config.yml
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target
EOF

sudo mkdir -p /etc/flatrun
sudo systemctl daemon-reload
sudo systemctl enable --now flatrun-agent

Install UI

The web dashboard for managing your deployments through a browser.

Latest Build All Releases

Download the dist artifact and serve with any web server

Nginx Configuration

server {
    listen 80;
    server_name flatrun.example.com;
    root /var/www/flatrun-ui/dist;
    index index.html;

    location / {
        try_files $uri $uri/ /index.html;
    }

    location /api {
        proxy_pass http://localhost:8090;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

Build from Source

Agent

git clone https://github.com/flatrun/agent.git
cd agent && go build -o flatrun-agent ./cmd/agent
./flatrun-agent --config config.yml

git clone https://github.com/flatrun/ui.git
cd ui && npm install && npm run build
# Serve the dist/ folder with any web server