Quick Start

This guide will have you from zero to deploying your first application in under 5 minutes.

Prerequisites

• A Linux server (Ubuntu 20.04+ recommended)
• Root or sudo access

Step 1: Install FlatRun

Run the installer script — it handles Docker, the agent, the UI, and the reverse proxy:

curl -fsSL https://get.flatrun.dev/install.sh | sudo bash

The installer takes about a minute. Once done, you'll see:

FlatRun is installed!
  Access the setup wizard at: http://YOUR_IP:8080/setup

Step 2: Complete Setup

Open the setup URL in your browser. The setup wizard will guide you through:

• Creating your admin account
• Configuring your domain (optional)
• Enabling SSL (optional)

Step 3: Deploy Your First App

On the projects page, click New and pick a source: a Git repository, a Docker image, a template (WordPress, Ghost, Laravel and more) or a compose file. Fill in a name and choose Deploy.

Your app will be live in seconds.

Using the API

Everything in the UI is also available via REST API:

# Authenticate and get a token
TOKEN=$(curl -s -X POST http://localhost:8090/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"api_key": "your-api-key"}' | jq -r '.token')

# List available templates
curl -s http://localhost:8090/api/templates \
  -H "Authorization: Bearer $TOKEN" | jq '.[] | .id'

# Create a WordPress deployment
curl -X POST http://localhost:8090/api/deployments \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-wordpress",
    "template_id": "wordpress",
    "auto_start": true
  }'

What's Next?