About Airbox FAQ

Connecting Applications

Arq Cyberduck ForkLift Rclone Restic

Technical Information

Service Endpoints S3 Compatibility

About Restic

Restic is a free open-source backup tool designed for advanced users who are comfortable using the command line. The GitHub source code repository can be found here.

The basic functionality of Restic has been tested with Airbox. However, if you experience any problems, please contact support.

The restic documentation provides more comprehensive setup instructions than this simplified walk-through.

1. Install Restic

Restic installation happens from the Terminal.

For MacOS, run (assuming you have homebrew:

brew install restic

For Linux, see this page for the particular distribution you're using.

For Windows users, download and install the 64-bit Windows exe or the 32-bit Windows exe.

2. Setup a Backup Repository

Restic starts by establishing some location as the destination where your backups will be held, which they call a Repository. You can use a bucket in your Airbox as a Restic repository. Restic needs your Airbox's Access Key and Secret Key to be in environment variables in order to work.

The command to setup a bucket in your Airbox as a repository looks like:

export AWS_ACCESS_KEY_ID=YourAirboxAccessKey \
export AWS_SECRET_ACCESS_KEY=YourAirboxSecretKey \
restic --repo init

The bucket name you choose doesn't already need to exist, Restic will create it for you if it's missing.

3. Perform the Backup

After you have a repository setup, you can backup a directory. This is done with the following command:

restic --repo backup ./path-to-directory-to-backup

(If this doesn't work, make sure your environment variables are set properly.)

4. Perform a Restore

If you need to restore a backup, the command is:

restic --repo restore latest --target ./path-to-restore-directory