Skip to content

feat: show installer progress as steps with a spinner and a log file - #244

Open
imrja8 wants to merge 2 commits into
mainfrom
feat/installer-ui
Open

imrja8 wants to merge 2 commits into
mainfrom
feat/installer-ui

Conversation

@imrja8

@imrja8 imrja8 commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

What

install.sh (install and update) now shows clear progress instead of raw command output, when it runs in a terminal:

  • Numbered steps ([3/9]), each with a spinner and then a one-line result: a detail such as the Docker version or the advertise address, plus the time taken for slow steps.
  • A log file. Raw output from Docker, apt and get.docker.com goes to /var/log/dokploy-install.log. The file is mode 600 and appended on every run. If /var/log isn't writable, it uses a temp file instead; if no log file can be written at all, output streams as before.
  • On failure, the script shows the error, a hint and the last lines of the log.
  • A final summary with the dashboard URLs, the version, the total time and the log path. If the PostgreSQL or Dokploy service could not be created, it now says "Installation finished, but Dokploy did not start" instead of "Congratulations". The exit code is still 0, as before.
  • Ctrl+C prints "Cancelled." and restores the cursor. Long step labels are cut to the terminal width, so the spinner never wraps.
  • Symbols and colors. Unicode symbols are used only with a UTF-8 locale, with ASCII otherwise, and NO_COLOR is respected.

When output is not a terminal (CI, redirected to a file), command output streams as before, under plain [n/9] step headers, and the final messages keep their original wording.

What did not change

  • The same commands run in the same order, with the same flags, checks, error exits and exit codes.
  • The same environment variables are honored: DOKPLOY_VERSION, ADVERTISE_ADDR, DOCKER_SWARM_INIT_ARGS and ENDPOINT_MODE, plus Proxmox LXC detection.
  • /etc/dokploy keeps the same permissions.
  • The script is still POSIX sh, so curl … | sh keeps working where sh is dash.
  • The release workflow still works: the shebang stays on line 1 and DOKPLOY_VERSION support is kept, so the pinned copy it builds is unaffected.
  • The only addition: when Docker is already installed, one read-only docker --version call to show which version was found.

Testing

  • Same commands as before. I ran 16 scenarios under dash with stub docker, curl, ss, ip, openssl and apt-mark commands that record every call. Each scenario ran with the old and the new script, both piped and in a TTY, and produced the same calls in the same order and the same exit codes.
    • The scenarios: default; Docker not installed; Proxmox LXC; ENDPOINT_MODE=dnsrr; custom DOCKER_SWARM_INIT_ARGS; ADVERTISE_ADDR; DOKPLOY_VERSION=canary; GitHub unreachable; port 80 in use; docker swarm init failing; the PostgreSQL service failing; an unsupported distro; a full disk; not running as root; update; update with a full disk.
    • Exit codes were also compared under bash.
  • The pinned release copy of the script works with the new installer.
  • Static checks: dash -n passes, and ShellCheck (-s sh) reports no new findings compared with the current script.
  • A real install on a fresh Ubuntu 24.04 server, Docker included, worked.

The repo's CI doesn't check shell scripts, so these checks were run by hand.

Screenshots

Before:
PHOTO-2026-11-18-01-28-22

After:
PHOTO-2026-11-18-01-27-48

@imrja8
imrja8 requested a review from Siumauricio as a code owner November 17, 2026 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants