You are not reading the latest stable version of this documentation. If you want up-to-date information, please have a look at master.

Service Backups

Everything within the root of the mounted volume directory will be stored in an EmbassyOS backup. This includes the config (config.yaml) and properties (stats.yaml) files, as well as any other persisted data within the volume directory.

For restoration purposes, it might be beneficial to ignore certain files or folders. For instance, ignore the shared/public folder that is mounted for dependencies that expose this feature as it causes data inconsistencies on restore.

In this case, create a .backupignore file. This file contains a list of relative paths to the ignored files.


The btcpayserver wrapper demonstrates a good use of a backupignore template.

Ultimately, /datadir/.backupignore gets populated with: