Though any files can be backed up, It is created for docker files (docker-compose.yaml) etc.
rename .env.sample
to .env
and rename the variables accordingly
Note the following:
-
for environment variables
FILENAME
: The file name will be appended to the file after the date eg2011-01-01-MYBACKUP.tar.gz
ARCHIVE_PATH
: This needs to be absolute pathDOCKER_CONTAINERS
: Containers to stop before archiving, ifall
is set, it will stop all containers andnone
will not stop any containers (recommended if you are not backing docker containers)GNUPG_RECIPIENTS
: Which GPG Key to use for encryptionBACKUP_COPIES
: How many recent copies to keep, the rest will be deletedDATE_FORMAT
: Date format, uses Python datetime strftime formatNTFY_URL
&NTFY_AUTH
are both optional
-
Before running, ensure you have a GPG key,
client.secrets.json
andcredentials.json
, else runget_gdrive_token.py
to getcredentials.json