Skip to content

Installation EN

Jump to bottom
blacksheep8732 edited this page Sep 18, 2026 · 2 revisions

🇩🇪 Deutsche Version

Installation

TasmoBackup-py runs as a Docker container. The prebuilt image is on GitHub:

ghcr.io/blacksheep8732/tasmobackup-py:latest

Besides latest there are fixed versions such as 0.2.0 or 0.2 if you don't want every new release automatically.

Unraid (Community Apps)

  1. In Unraid go to Apps and search for TasmoBackup-py.
  2. Click Install.
  3. In the form:
    • WebUI: port of the web interface (default 8259).
    • Appdata: folder for the database, the key and all backups (default /mnt/user/appdata/tasmobackup-py).
    • Admin user / Admin password: your login for the web interface.
  4. Apply – the interface is then available at http://<unraid-ip>:8259.

Important

Admin user and Admin password only apply on the very first start. After that the password is stored (hashed) in the database and changed under Settings. Changing the field in the Unraid form later has no effect – see Troubleshooting for resetting a forgotten password.

Show more settings reveals further fields (default Tasmota credentials, key, PUID/PGID). Most installations can leave them as they are.

Updates: Unraid shows "update available" on the Docker tab when a new version is released. Clicking Update is enough; data and key are kept.

Docker / Docker Compose

services:
  tasmobackup:
    image: ghcr.io/blacksheep8732/tasmobackup-py:latest
    container_name: tasmobackup-py
    ports:
      - "8259:8000"
    volumes:
      - ./data:/data
    environment:
      - TB_ADMIN_USER=admin
      - TB_ADMIN_PASSWORD=please-change
      - PUID=1000
      - PGID=1000
      - TZ=Europe/Berlin
    restart: unless-stopped

Or without Compose:

docker run -d --name tasmobackup-py -p 8259:8000 \
  -v /path/to/data:/data \
  -e TB_ADMIN_PASSWORD=please-change -e PUID=1000 -e PGID=1000 \
  ghcr.io/blacksheep8732/tasmobackup-py:latest

Environment variables

Variable Default Meaning
TB_ADMIN_USER admin login name – first start only
TB_ADMIN_PASSWORD admin login password – first start only
TB_SECRET_KEY (automatic) key for sessions and the encrypted passwords. Leave empty to have one generated on first start and stored as .secret_key in the data folder.
TB_TASMOTA_USER / TB_TASMOTA_PASSWORD admin / (empty) credentials for devices that have none of their own
TB_AUTH_ENABLED true false disables the login – only sensible behind a proxy with its own authentication
PUID / PGID 1000 / 1000 user/group the app runs as (Unraid template: 99 / 100)
TZ – time zone of the log output. The time zone shown in the interface is set under Settings → Timezone.
TB_DATABASE_URL (SQLite in the data folder) a different database instead of SQLite. Currently not usable with the prebuilt image – the MySQL/PostgreSQL drivers are not included. Leave empty.
TB_CONCURRENCY 15 how many devices are contacted in parallel
TB_HTTP_TIMEOUT 15 seconds to wait for a device

The data folder

Everything that must be kept lives in the mapped folder (/data inside the container):

tasmobackup.db           database (devices, settings, events)
.secret_key              key (only when TB_SECRET_KEY is empty)
backups/<device>/…       the backup files
tasmota-release.json     cached Tasmota release info

Warning

Back this folder up (e.g. with the Appdata Backup plugin) – including .secret_key. Without the key, stored device and MQTT passwords can no longer be decrypted (the backups themselves stay readable).

The container fixes file ownership on start: anything in the data folder not owned by PUID:PGID is changed automatically.

🏠 Start / Home

🇩🇪 Deutsch

🇬🇧 English

Repository · Issues

Clone this wiki locally