Docker containers for actualbudget backup to remote.
Heavily inspired at vaultwarden-backup
Important: We assume you already read the
actualbudgetdocumentation. And have an insteance up and running.
For backup, you need to configure Rclone first, otherwise the backup tool will not work.
For restore, it is not necessary.
We upload the backup files to the storage system by Rclone.
Visit GitHub for more storage system tutorials. Different systems get tokens differently.
You can get the token by the following command.
docker run --rm -it \
--mount type=volume,source=actualbudget-rclone-data,target=/config/ \
rodriguestiago0/actualbudget-backup:latest \
rclone configWe recommend setting the remote name to ActualBudgetBackup, otherwise you need to specify the environment variable RCLONE_REMOTE_NAME as the remote name you set.
After setting, check the configuration content by the following command.
docker run --rm -it \
--mount type=volume,source=actualbudget-rclone-data,target=/config/ \
rodriguestiago0/actualbudget-backup:latest \
rclone config show
# Microsoft Onedrive Example
# [ActualBudgetBackup]
# type = onedrive
# token = {"access_token":"access token","token_type":"token type","refresh_token":"refresh token","expiry":"expiry time"}
# drive_id = driveid
# drive_type = personalDownload docker-compose.yml to you machine, edit environment variables and start it.
You need to go to the directory where the docker-compose.yml file is saved.
# Start
docker-compose up -d
# Stop
docker-compose stop
# Restart
docker-compose restart
# Remove
docker-compose downStart the backup container with default settings. (automatic backup at 12AM every day)
docker run -d \
--restart=always \
--name actualbudget_backup \
--mount type=volume,source=actualbudget-rclone-data,target=/config/ \
rodriguestiago0/actualbudget-backup:latestNote: All environment variables have default values, you can use the docker image without setting any environment variables.
The name of the Rclone remote, which needs to be consistent with the remote name in the rclone config.
You can view the current remote name with the following command.
docker run --rm -it \
--mount type=volume,source=actualbudget-rclone-data,target=/config/ \
rodriguestiago0/actualbudget-backup:latest \
rclone config show
# [ActualBudgetBackup] <- this
# ...Default: ActualBudgetBackup
The folder where backup files are stored in the storage system.
Default: /ActualBudgetBackup/
Rclone global flags, see flags.
Do not add flags that will change the output, such as -P, which will affect the deletion of outdated backup files.
Default: ''
Schedule to run the backup script, based on supercronic. You can test the rules here.
Default: 0 0 * * * (run the script at 12AM every day)
Only keep last a few days backup files in the storage system. Set to 0 to keep all backup files.
Default: 0
Each backup file is suffixed by default with %Y%m%d. If you back up your budget multiple times a day, that suffix is not unique anymore. This environment variable allows you to append a unique suffix to that date to create a unique backup name.
You can use any character except for / since it cannot be used in Linux file names.
This environment variable combines the functionalities of BACKUP_FILE_DATE and BACKUP_FILE_DATE_SUFFIX, and has a higher priority. You can directly use this environment variable to control the suffix of the backup files.
Please use the date man page for the format notation.
Default: %Y%m%d
Set your timezone name.
Here is timezone list at wikipedia.
Default: UTC
※ Other environment variables
You don't need to change these environment variables unless you know what you are doing.
You should use the BACKUP_FILE_SUFFIX environment variable instead.
Edit this environment variable only if you explicitly want to change the time prefix of the backup file (e.g. 20220101). Incorrect configuration may result in the backup file being overwritten by mistake.
Same rule as BACKUP_FILE_DATE_SUFFIX.
Default: %Y%m%d
You should use the BACKUP_FILE_SUFFIX environment variable instead.
Each backup file is suffixed by default with %Y%m%d. If you back up your budget multiple times a day, that suffix is not unique anymore.
This environment variable allows you to append a unique suffix to that date (%Y%m%d${BACKUP_FILE_DATE_SUFFIX}) to create a unique backup name.
Note that only numbers, upper and lower case letters, -, _, % are supported.
Please use the date man page for the format notation.
Default: ''
If you prefer using an env file instead of environment variables, you can map the env file containing the environment variables to the /.env file in the container.
docker run -d \
--mount type=bind,source=/path/to/env,target=/.env \
rodriguestiago0/actualbudget-backup:latestAs an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables. This causes the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files.
docker run -d \
-e ACTUAL_BUDGET_PASSWORD=/run/secrets/actual-budget-password \
rodriguestiag0/actualbudget-backup:latestWe will use the environment variables first, followed by the contents of the file ending in _FILE as defined by the environment variables. Next, we will use the contents of the file ending in _FILE as defined in the .env file, and finally the values from the .env file itself.
MIT