Repository navigation
Security
BorgStudio handles three kinds of secrets: repository passphrases, SSH keys for servers and Storage Boxes, and the repository keys borg encrypts with. None of them is ever stored in plain text.
Under Tools → Settings → Lock and vault you can set up a PIN (recommended):
- BorgStudio then starts locked and shows only a lock screen. Unlocking also opens the vault.
- The vault (
vault.json) is encrypted with AES-256-GCM under a key derived from your PIN with Argon2id. Without the PIN nothing in it can be read. - BorgStudio locks itself again after a time without use (15 minutes by default, adjustable or off), or at once with Ctrl+L or the lock button in the status bar. Locking closes all dialogs.
- A forgotten PIN cannot be recovered. Forgot PIN? resets the vault: everything stored in it is lost (the repositories themselves are not touched, but you need their passphrases and SSH keys again).
Per repository (Repositories):
| Choice | Notes |
|---|---|
| Vault | Encrypted with your PIN; needs a PIN. Recommended. |
| System keychain | Windows Credential Manager, macOS keychain, Secret Service on Linux (GNOME Keyring, KWallet) |
| Not stored | Asked for every time |
Tools → SSH keys manages the login keys for SSH servers and Storage Boxes. They are kept encrypted in the vault, so SSH repositories need a PIN.
- Create a new key, or import an existing key file (a password on the file is removed once – the vault protects the key). The original file stays where it is.
- One key can serve several repositories. Rename, copy the public key, save the private key, delete unused keys.
- For a borg call the key is written to a private temporary file – next to the known hosts in BorgStudio's data
folder, or in
~/.borgstudio/sshinside WSL – and deleted right after. - Confirmed server host keys (
known_hosts) are kept in thesshsub folder of the data folder. - Server passwords are only used once to install a key and are never stored.
repokey repositories keep their key inside the repository, protected by the passphrase. Export key in a
repository's overview saves a copy – keep it separate from the passphrase. With keyfile repositories the key lives
in borg's key folder on this computer; exporting your settings can include it.
BorgStudio talks only to your repositories and, for updates, to GitHub's public release list. There is no telemetry.