Skip to main content

Installation

The fastest way to a running instance is the interactive installer. It detects your local Docker setup, asks what it can't infer, writes a compose (or Swarm stack) file, deploys it, and prints the URL and first-boot password.

Requirements​

  • A host with Docker (Docker Desktop, Rancher Desktop, colima, or a native Linux engine).
  • Access to a Docker socket — by default /var/run/docker.sock.
  • One free port for the UI (default 8080).

Install with the script​

Download it, read it, then run it:

curl -fsSL https://raw.githubusercontent.com/sol2docker/installer/main/install.sh -o install.sh
bash install.sh

Or accept all documented defaults non-interactively:

curl -fsSL https://raw.githubusercontent.com/sol2docker/installer/main/install.sh | bash -s -- --yes
Piping into bash is non-interactive

Under curl … | bash there is no terminal for prompts. The installer will refuse to guess and stop, unless you pass --yes (which accepts every documented default). To answer prompts yourself, download the script first and run bash install.sh.

Preview without changing anything​

--dry-run walks the entire flow — running the real detection probes — while writing, starting, and installing nothing:

bash install.sh --dry-run

Options​

FlagEffect
--yesAccept all defaults; required when piped into bash.
--dry-runWalk the flow and print what would happen; change nothing.
--dir <path>Where to write the generated config (default ~/.sol2docker).

What it asks​

  • Standalone or Swarm — detected from your daemon; Swarm pins the service to the node you deploy from (see deploy manually).
  • Port to publish the UI on (default 8080).
  • HTTPS handling — none, or terminate TLS.
  • Whether to attach an additional Docker network (e.g. your reverse proxy's).
  • Whether to also deploy the optional node agent.

When it finishes it prints the URL and the generated admin password.

After it runs​

Open the URL it printed (e.g. http://localhost:8080) and sign in as admin with the generated password. Then head to Configuration to understand the encryption key, data location, and the SOL2DOCKER_* settings.

Prefer to write the compose file yourself?

The installer only writes a compose file and brings it up — nothing stops you doing it by hand. See Deploy manually.