Howto: Using borg that is delivered with the flatpak build of Vorta

[goebbe]

The flatpak build of Vorta includes a binary of borg.
The following shows how to access and use this "included borg binary" from the command line.

Background: Vorta provides access to many features and options of borgbackup. However, sometimes executing borg commands directly can be useful, e.g. to access borg features that are not accessible via Vorta GUI.
Since a borg binary is included in the flatpak build of Vorta, it is not necessary to install another version of borg.
The following shows how to access and use this borg binary from the command line.

The examples have been tested on Linux Mint 22.1 with the flatpak build of Vorta 0.10.3 (from flathub) that includes borg 1.4.0.

Useful commands:

1. Start flatpak Vorta from the command line:
   flatpak run com.borgbase.Vorta

2. Start borg that is included in the flatpak build of Vorta:
   flatpak run --command=borg com.borgbase.Vorta

3. Print the --version number of the included borg client binary:
   flatpak run --command=borg com.borgbase.Vorta --version

4. Export repo-key (to keep it in a save place, e.g. in your password manager, see issue add UI for borg key backup #1918):
   flatpak run --command=borg com.borgbase.Vorta key export /path/repo > ~/encrypted-repo-key-backup.txt
   for a remote backup, via ssh:
   flatpak run --command=borg com.borgbase.Vorta key export ssh://[email protected]:22/~/path/repo > ~/encrypted-repo-key-backup.txt

5. Display the borg client version / borg server version
   flatpak run --command=borg com.borgbase.Vorta version ssh://[email protected]:22/~/path/repo

6. Unlock a locked borg repository - if a backup is interrupted, in some cases the backup repository remains locked - and one cannot make a new backup to an (already) locked backup.
   (Use with caution - read the borg docs before you break the lock)
   flatpak run --command=borg com.borgbase.Vorta break-lock /path/repo

Feel free to comment or add more examples below.