Getting Started¶
Install BorgBackup
Before proceeding further, make sure you have BorgBackup installed on your system. It is not bundled with BorgBoi currently.
Read installation methods here: https://borgbackup.readthedocs.io/en/stable/installation.html.
Installation¶
BorgBoi isn't published to PyPI yet, so it is recommended to install it from the GitHub repo with uv.
Additionally, BorgBackup needs to be installed on your system for BorgBoi to work.
Read installation methods here: https://borgbackup.readthedocs.io/en/stable/installation.html.
Provision AWS Resources¶
For BorgBoi to function properly, it requires an S3 bucket and DynamoDB table.
Use the IAC present in the terraform directory to provision these resources on AWS with Terraform or OpenTofu.
Configuring Environment¶
AWS Credentials¶
Before running BorgBoi, make sure the shell BorgBoi runs in has access to AWS credentials with sufficient permissions for the DynamoDB table and S3 bucket.
BorgBoi Environment Variables¶
The following environment variables must be set.
| Name | Description |
|---|---|
BORG_NEW_PASSPHRASE |
Passphrase to use for securing any new Borg repositories |
BORG_PASSPHRASE |
Passphrase to use for accessing any Borg repositories on your system |
BORG_S3_BUCKET |
Name of the S3 bucket responsible storing Borg repositories |
BORG_DYNAMODB_TABLE |
Name of the DynamoDB table responsible for storing repo metadata |
Create a BorgBoi Repo¶
You can now create a Borg repository with the following BorgBoi command:
