Updating from the web UI

When a newer version is published, ipmideck shows a notification once, and an upgrade button stays next to the version in the sidebar until you install it: an arrow pointing up, or a shield for a security release. Both open the release notes of the new version and, when ipmideck can install it itself, a Download and install button.

What the button does

Before changing anything, ipmideck backs up the database, the encryption key, and config.yaml to backups/ in the data directory.

Installed with	Result
pip in a virtual environment, pipx, uv	Installs the new version and restarts ipmideck. The page reloads by itself when the new version is running.
pip, pipx, or uv on Windows	ipmideck stops so the update can be installed, then you start it again. Progress is written to `update.log` in the data directory.
Docker with Watchtower	Watchtower pulls the new image and replaces the container. The page reloads by itself.
Docker without Watchtower	The dialog shows the command to run on the Docker host.
git checkout, system Python, editable install	The dialog explains why and shows the command to run; a Python managed by the system is updated the way it was installed.

Requirements

The login must be on: the button replaces the running program.
The button is not available in demo mode.
To restart by itself, ipmideck must have been started with the ipmideck command. Started any other way, it installs the update and asks you to restart it; on Windows it shows the command instead.

Docker with Watchtower

A container cannot replace its own image, and giving ipmideck access to the Docker socket would give it control of the host. A separate Watchtower container does the replacement when ipmideck asks for it.

Label the ipmideck container

Start ipmideck with the label that lets Watchtower manage it:

docker run -d --name ipmideck --network host \
  --label com.centurylinklabs.watchtower.enable=true \
  -v ipmideck-data:/data devluigi06/ipmideck:latest

Start Watchtower

Start Watchtower with its HTTP API on, reachable only from the host:

docker run -d --name watchtower \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -p 127.0.0.1:8080:8080 \
  -e WATCHTOWER_HTTP_API_UPDATE=true \
  -e WATCHTOWER_HTTP_API_TOKEN=replace-with-a-long-random-token \
  -e WATCHTOWER_LABEL_ENABLE=true \
  nickfedor/watchtower

Connect ipmideck

Add the address of Watchtower and its token under the updates: section that config.yaml already has, then restart ipmideck:

config.yaml

updates:
  watchtower_url: http://127.0.0.1:8080
  watchtower_token: replace-with-a-long-random-token

The same settings are available as IPMIDECK_UPDATES_WATCHTOWER_URL and IPMIDECK_UPDATES_WATCHTOWER_TOKEN. With Docker Compose, where both containers share a network, use http://watchtower:8080 as the address.

Watchtower controls Docker through its socket. Use a long random token, and keep its port bound to 127.0.0.1 as shown.

Watchtower pulls the tag the container already uses. With latest it moves to the newest release; a container pinned to a version tag (for example 2.0.0) stays on it.

If the install fails

The dialog shows the reason and the installer output, together with the command to install the update manually. Nothing is removed: the backup made before the install is in backups/, and Backup & restore explains how to restore it.

Next steps

Updating ipmideck: update from the command line.
Backup & restore: snapshot your data before upgrading.

Getting Started

Installation

Running

Configuration

CLI & Console

Features

Supported Hardware

Reference

Updating from the web UI

What the button does

Requirements

Docker with Watchtower

If the install fails

Next steps

​What the button does

​Requirements

​Docker with Watchtower

​If the install fails

​Next steps

What the button does

Requirements

Docker with Watchtower

If the install fails

Next steps