Skip to content
Supermetry

Install Supermetry

Install Supermetry interactively or unattended on Linux, macOS or Windows.

Use the release installer to configure a Docker or binary deployment.

Requirements

Section titled “Requirements”
  • Linux, macOS or Windows on AMD64 or ARM64.
  • curl or wget on Linux and macOS, or PowerShell on Windows.
  • Docker Compose for Docker mode, or a reachable PostgreSQL database for binary mode.
  • Root or sudo access for a Linux binary service install.

Interactive install

Section titled “Interactive install”

  1. On Linux or macOS, run:

    Terminal window
    curl -fsSL https://github.com/velixio/supermetry/releases/latest/download/install.sh | sh

    On Windows, open PowerShell and run:

    Terminal window
    irm https://github.com/velixio/supermetry/releases/latest/download/install.ps1 | iex

  2. Answer the prompts in their implemented order:

    Prompt Default Flag
    Install mode (binary or docker) binary --mode
    Public URL none --base-url
    Listen address 127.0.0.1:8787 --listen
    Reverse proxy on Linux (nginx, caddy or none) none --proxy
    Docker install directory /opt/supermetry on Linux; ./supermetry elsewhere --dir
    Docker image source (download or build) download --image
    Database URL, or leave blank for separate settings blank --database-url
    Database host localhost --db-host
    Database port 5432 --db-port
    Database user supermetry --db-user
    Database password none --db-password
    Database name supermetry --db-name
    Database SSL mode disable for localhost; require otherwise --db-sslmode
    Replace an existing generated file no --yes
    Apply a non-root Linux binary plan with sudo no --yes

    Docker mode asks the two Docker questions and skips the database questions. Binary mode asks the database questions and skips the Docker questions. Replacement and sudo confirmations appear only when needed.

  3. For an unattended Docker install, download the script first so its flags reach supermetry install:

    Terminal window
    curl -fsSLO https://github.com/velixio/supermetry/releases/latest/download/install.sh
    sh install.sh --yes --mode docker --base-url https://analytics.example.com --listen 127.0.0.1:8787 --proxy none --image download --dir /opt/supermetry

    With --yes, --mode and --base-url are required. Binary mode also requires --database-url, or --db-host and --db-password; port, user and database name retain the defaults above. Missing values and failed database checks stop the install.

  4. Optionally preview the whole install first. --dry-run prints every file, command, user, service and proxy change that would happen, and changes nothing, including no database connection. It never asks questions, so it works non-interactively:

    Terminal window
    sh install.sh --dry-run --mode docker --base-url https://analytics.example.com

  5. Open <url>/app and create the first admin account. The password must contain at least 6 characters.

What you should see: the installer reports Open <url>/app to create your admin account. If the database already has an admin, it reports Open <url>/app and sign in with your existing admin account instead.

Safety checks

Section titled “Safety checks”

For a binary install the installer checks the database before it writes anything:

  • PostgreSQL 14 or newer is required; an older server stops the install. Below PostgreSQL 18 it continues with a warning, because 18 is the tested baseline.
  • The listen port must be free, unless this installer already wrote its environment file. If it is in use, choose another value with --listen.
  • A Linux binary install needs systemd and stops with a hint to use --mode docker otherwise.

Run supermetry install --help to see every flag with examples.

Section titled “Related”