Getting Started

Get Go-Upkeep running in under a minute with Docker Compose. This guide covers prerequisites, installation, initial user setup, and your first SSH connection.

1. Prerequisites

  • A Linux server (VPS, Raspberry Pi, or local VM).
  • Docker and Docker Compose installed.
  • An SSH key pair (id_ed25519 or id_rsa) on your local machine.

2. Installation

Create a file named docker-compose.yml:

docker-compose.ymlyaml
services:
  monitor:
    image: rdgames1000/go-upkeep:latest
    container_name: go-upkeep
    restart: unless-stopped
    stdin_open: true   # Required for initial setup
    tty: true
    ports:
      - "23234:23234"  # SSH
      - "8080:8080"    # HTTP API & Status Page
    volumes:
      - ./data:/data
    environment:
      - UPKEEP_DB_TYPE=sqlite
      - UPKEEP_DB_DSN=/data/upkeep.db
      - UPKEEP_STATUS_ENABLED=true
      - UPKEEP_CLUSTER_SECRET=change_me_to_secure

Run the stack:

Terminal
docker compose up -d

3. Creating the First User

In V2, authentication uses database-backed SSH keys. You cannot SSH in until you create the first user via the server console.

Attach to the running container:

Terminal
docker attach go-upkeep

You will see the Dashboard. Follow these steps:

  • Press Tab until you reach the Users tab.
  • Press n to create a New User.
  • Enter a username (e.g., admin).
  • Paste your public key (found in ~/.ssh/id_ed25519.pub on your computer).
  • Press Enter to save.
Detach safely by pressing Ctrl+P followed by Ctrl+Q. Do not press Ctrl+C or you will stop the container.

4. Connecting

Now you can connect from your local machine:

Terminal
ssh -p 23234 admin@your-server-ip

What's next?