This is a quick-start tutorial that covers Restic usage with Tardigrade. In this guide, we will cover only some of the basic features. For taking the most advantage of Restic, look at their complete command reference.
You will need the following:
First, install Restic for your operating system, then execute the init command:
restic --repo rclone:tardigrade:bucket/my-backup init
--repo defines that we will use
rclone as a tool for backup with
tardigrade configuration. The last part
bucket/my-backup specifies where our backup will be stored remotely.
tardigrade refers to the
rclone configuration name which you chose during setup.
Now, enter a password for your repository.
Repository data will be created directly at the specified bucket prefix e.g.
Now you are ready to do your first backup!
Execute the backup command:
restic --repo rclone:tardigrade:bucket/my-backup backup ~/directory-to-backup
You will be able to see the progress of the backup and a summary at the end of the process.
With every backup, Restic is creating a new snapshot with contents of a directory at the moment. To remove old and unused snapshots we need to execute the
restic --repo rclone:tardigrade:bucket/my-backup forget --keep-last 2 --prune
--keep-last flag is for keeping last
n snapshots. This command offers multiple flags for defining deletion rules. See
restic help forget for more options.
--prune flag is for removing unreferenced data. Without this option, the
forget command will remove the snapshot but not the referenced data.
If you want to verify the consistency of your backup, run the
restic --repo rclone:tardigrade:bucket/my-backup check
To restore the latest snapshot of your backup:
restic --repo rclone:tardigrade:bucket/my-backup restore latest --target ~/restore
latest option means we want to restore the latest snapshot.
--target flag defines the directory where the backup will be restored.
For more detailed information, please visit the Restic documentation page.