- 📥 Set up backups
- 🔀 Make per-application backups
- 🔒 Provide your passwords
- ☁️ Make backups redundant
- 📏 Deal with very large backups
- 🔎 Inspect your backups
- 🚨 Monitor your backups
- 📤 Extract a backup
- 🗄️ Backup your databases
- 🧹 Add preparation and cleanup steps
- 💾 Backup to a removable drive/server
- 🔧 Run arbitrary Borg commands
- 📦 Upgrade borgmatic
- 🏗️ Develop on borgmatic
- Reference guides
Environment variable interpolation ¶
If you want to use a Borg repository passphrase or database passwords with borgmatic, you can set them directly in your borgmatic configuration file, treating those secrets like any other option value. But if you'd rather store them outside of borgmatic, whether for convenience or security reasons, read on.
borgmatic supports interpolating arbitrary environment variables directly into option values in your configuration file. That means you can instruct borgmatic to pull your repository passphrase, your database passwords, or any other option values from environment variables. For instance:
This uses the
MY_PASSPHRASE environment variable as your encryption
passphrase. Note that the
} brackets are required. Just
will not work.
In the case of
encryption_passphrase in particular, an alternate approach
is to use Borg's
BORG_PASSPHRASE environment variable, which doesn't even
require setting an explicit
encryption_passphrase value in borgmatic's
For database configuration, the same approach applies. For example:
- name: users
This uses the
MY_DATABASE_PASSWORD environment variable as your database
Interpolation defaults ¶
If you'd like to set a default for your environment variables, you can do so with the following syntax:
defaultpass" is the default passphrase if the
environment variable is not set. Without a default, if the environment
variable doesn't exist, borgmatic will error.
Disabling interpolation ¶
To disable this environment variable interpolation feature entirely, you can
--no-environment-interpolation flag on the command-line.
Or if you'd like to disable interpolation within a single option value, you
can escape it with a backslash. For instance, if your password is literally
Related features ¶
Another way to override particular options within a borgmatic configuration file is to use a configuration override on the command-line. But please be aware of the security implications of specifying secrets on the command-line.
Additionally, borgmatic action hooks support their own variable interpolation, although in that case it's for particular borgmatic runtime values rather than (only) environment variables.
Improve this documentation
Have an idea on how to make this documentation even better? Use our issue tracker to send your feedback!