◀️ back to "Official ioBroker Docker Image Docs - Backup"

Work In Progress

⚠️ This documentation is still work in progress. If you got any improvements simply let me know by opening an issue or edit it by yourself and create a pull request. Thank you.

Backup remote databases with iobroker.backitup

By default, the options for backing up remote databases are grayed out in iobroker.backitup settings when running inside a Docker container. This is made because backing up remote databases is not working "out of the box". This guide will give some information about how to make the settings available and what needs to be done to get the backup working.

Prerequisites

To run a backup of external databases the container must fulfill some prerequisites. In some cases the prerequisites depend on the cpu architecture your Docker container is running on. To find out which architecture your ioBroker Docker container is running on take a look at the container log on startup. You will find something like this:

--------------------------------------------------------------------------------
-----                          System Information                          -----
-----                    arch:                x86_64                       -----
-----                    hostname:            iobroker                     -----

Redis

Note

Restoring a remote redis database from iobroker.backitup ui is not supported! You have to restore the backup manually. For details see iobroker.backitup docs.

x86_64

  • add redis-toolsto PACKAGES environment variable to fulfill prerequisites

aarch64

Sorry, no information available/ not tested yet!

armv7l

Sorry, no information available/ not tested yet!


InfluxDB

The following is valid for all supported cpu architectures.
You need to run ioBroker Image Version v8.1.0 or greater.

To fulfill the prerequisites for running an InfluxDB backup/ restore with ioBroker.backitup adapter you need to add the following packages to your containers environment variable PACKAGES:

...for InfluxDB v1.8 and older add influxdb

...for InfluxDB InfluxDB v2 and newer add influxdb2-cli

Note

It is not possible to install both packages together. So it is only possible to backup a InfluxDB v1.8 and older OR an InfluxDB v2 and newer.


MySQL

x86_64

  • add default-mysql-client to PACKAGES environment variable to fulfill prerequisites

aarch64

Sorry, no information available/ not tested yet!

armv7l

Sorry, no information available/ not tested yet!


Postgres SQL

x86_64

Sorry, no information available/ not tested yet!

aarch64

Sorry, no information available/ not tested yet!

armv7l

Sorry, no information available/ not tested yet!

Enable options in iobroker.backitup

To enable the greyed out checkboxes in iobroker.backitup settings you simply have to configure the environment variable IOB_BACKITUP_EXTDBand set it to true. For more information see Environment variables (ENV).

 

⚠️ Work In Progress ⚠️

This documentation is still work in progress. If you got any improvements simply let me know by opening an issue or edit it by yourself and create a pull request.

If you got any unanswered questions please join the ioBroker community on Discord, Telegram, Facebook or ioBroker Forum.

Last Updated: