upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-05-28 04:03:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #9621 from borgbackup/backport-9614-to-master

Browse source 
[Backport master] docs: improve macOS Keychain instructions (fixes #5156)
This commit is contained in:
TW 2026-05-13 10:03:39 +02:00 committed by GitHub
commit 7c8fa4e787
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/faq.rst
View file

@ -493,15 +493,25 @@ Using ``BORG_PASSCOMMAND`` with macOS Keychain
the built-in ``security`` command, you can access it from the command line,
making it useful for ``BORG_PASSCOMMAND``.
First generate a passphrase and use ``security`` to save it to your login
(default) keychain::
To store an existing passphrase in your login (default) keychain::
security add-generic-password -D secret -U -a $USER -s borg-passphrase -w $(head -c 32 /dev/urandom | base64 -w 0)
security add-generic-password -a $USER -s borg-passphrase -w YOUR_PASSPHRASE
Alternatively, to generate a new random passphrase and store it::
security add-generic-password -a $USER -s borg-passphrase -w $(head -c 32 /dev/urandom | base64 -w 0)
In your backup script retrieve it in the ``BORG_PASSCOMMAND``::
export BORG_PASSCOMMAND="security find-generic-password -a $USER -s borg-passphrase -w"
.. note::
If you run ``borg`` using ``sudo``, you must use the ``-E`` (preserve environment)
flag to ensure ``BORG_PASSCOMMAND`` is available and executed as the correct
user to access the keychain::
sudo -E borg create ...
Using ``BORG_PASSCOMMAND`` with GNOME Keyring
GNOME also has a keyring daemon that can be used to store a Borg passphrase.
First ensure ``libsecret-tools``, ``gnome-keyring`` and ``libpam-gnome-keyring``