Skip to content

EasyRunner CLI Docs

EasyRunner is a CLI-first way to turn your own Ubuntu server into a secure web host for containerized apps. These docs are organized around the model you need to understand, then the tasks you need to complete.

  • Concepts

    Learn the shape of EasyRunner: control plane, web host, app, service, deploy flow, link, and mesh.

    Start with concepts

  • Quickstart

    Install the CLI, prepare a server, and deploy your first app over HTTPS.

    Deploy your first app

  • Setup

    Install EasyRunner, run first-time setup, install a license, and link external services.

    Prepare the CLI

  • Servers

    Create a Hetzner server with EasyRunner or bring an existing Ubuntu server.

    Set up a web host

  • Apps

    Add apps, configure Compose-format files, choose a deploy flow, manage secrets, and operate deployments.

    Deploy apps

  • Reference

    Command reference, Compose-format labels, and troubleshooting notes for when something needs a closer look.

    Use the reference

The Short Version

flowchart LR
    install[Install CLI] --> setup[Run setup]
    setup --> host[Prepare web host]
    host --> add[Add app]
    add --> deploy[Deploy]
    deploy --> operate[Operate]

The main split happens when you prepare a web host:

Need a server?
├── Let EasyRunner create one on Hetzner
│   └── er link hetzner ... + er server create <name> hetzner
└── Bring an existing Ubuntu server
    └── er server add <name> <ip> + authorize the generated SSH key

Both paths converge at:
└── er server init <name> --username <user>

New to EasyRunner?

Read EasyRunner in One Page, then follow Deploy Your First App. That gives you the concepts and the practical path without making you read every reference page first.

Pick Your Path

Use this path when you want EasyRunner to create the server on Hetzner and you want to build your app from source on the web host.

  1. Install the CLI
  2. Run first-time setup
  3. Create a Hetzner server
  4. Deploy your first app

Use this path when you already have an Ubuntu server from any provider.

  1. Install the CLI
  2. Add an existing server
  3. Initialize the web host
  4. Add an app

Use this path when your pipeline already pushes container images to a registry.

  1. Understand deploy flows
  2. Configure Flow B
  3. Manage registry secrets
  4. Operate the app