Files
EOS/docs/develop/revert.md
Bobby Noelte d446274129
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
docker-build / platform-excludes (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
fix: Adapt versioning scheme to Home Assistant and switch to uv (#896)
Home Assistant expects versioning always increases numbers. Add
a date component to the development version to comply with this
expectation. The scheme is now 0.0.0.dev<date><hash>.

Use uv for creating and managing the virtual environment for developement.
This enourmously speeds up dependency updates. For this change
dependency requirements are now solely handled in pyproject.toml.
requirements.tx and requirements-dev.txt are deleted.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2026-02-23 20:59:03 +01:00

3.2 KiB

% SPDX-License-Identifier: Apache-2.0 (revert-page)=

Revert Guide

This guide explains how to revert AkkudoktorEOS to a previous version. The exact methods and steps differ depending on how EOS was installed:

  • M1/M2: Reverting when Installed from Source or Release Package
  • M3/M4: Reverting when Installed via Docker

:::{admonition} Important :class: warning Before reverting, ensure you have a backup of your EOS.config.json. EOS also maintains internal configuration backups that can be restored after a downgrade. :::

:::{admonition} Tip :class: Note If you need to update instead, see the Update Guideline. :::

Revert to a Previous Version of EOS

You can revert to a previous version using the same installation method you originally selected. See: Installation Guideline

Reverting when Installed from Source or Release Package (M1/M2)

1) Locate the target version (M2)

Go to the GitHub Releases page:

https://github.com/Akkudoktor-EOS/EOS/tags

2) Download or check out that version (M1/M2)

Git (source) (M1)

git fetch
git checkout v<version>

Example:

git checkout v0.1.0

Then reinstall dependencies:

uv sync

Release package (M2)

Download and extract the desired ZIP or TAR release. Refer to Method 2 in the Installation Guideline.

3) Restart EOS (M1/M2)

uv run python -m akkudoktoreos.server.eos

4) Restore configuration (optional) (M1/M2)

If your configuration changed since the downgrade, you may restore a previous backup:

  • via EOSdash

    Admin → configuration → Revert to backup

    or

    Admin → configuration → Import from file

  • via REST

    curl -X PUT "http://<host>:8503/v1/config/revert?backup_id=<backup>"
    

Reverting when Installed via Docker (M3/M4)

1) Pull the desired image version (M3/M4)

docker pull akkudoktor/eos:v<version>

Example:

docker pull akkudoktor/eos:v0.1.0

2) Stop and remove the current container (M3/M4)

docker stop akkudoktoreos
docker rm akkudoktoreos

3) Start a container with the selected version (M3/M4)

Start EOS as usual, using your existing docker run or docker compose setup (see Method 3 or Method 4 in the Installation Guideline).

4) Restore configuration (optional) (M3/M4)

In many cases configuration will migrate automatically. If needed, you may restore a configuration backup:

  • via EOSdash

    Admin → configuration → Revert to backup

    or

    Admin → configuration → Import from file

  • via REST

    curl -X PUT "http://<host>:8503/v1/config/revert?backup_id=<backup>"
    

About Configuration Backups

EOS keeps configuration backup files next to your active EOS.config.json.

You can list and restore backups:

  • via EOSdash UI
  • via REST API

List available backups

GET /v1/config/backups

Restore backup

PUT /v1/config/revert?backup_id=<id>

:::{admonition} Important :class: warning If no backup file is available, create or copy a previously saved EOS.config.json before reverting. :::