documentation: adapt ssh_identity and ssh_user option

also mention ssh-agent for ssh_identity option.
disable-ssh-password-prompt
Axel Burri 2022-02-22 20:36:49 +01:00
parent 2621fb38ba
commit dc7b11653d
1 changed files with 9 additions and 6 deletions

View File

@ -242,15 +242,18 @@ set to ``all'' (the default).
=== SSH Options === SSH Options
*ssh_identity* <file>:: *ssh_identity* <file>|no::
Absolute path to a ssh identity file (private key). Note that if Absolute path to a ssh identity file (private key). If not set,
the private key is password protected, btrbk will prompt for user the ssh default is used (see ssh(1), "-i identity_file"). Note
input, which is usually not desired. that if the identity key is password protected and no
authentication agent is used, btrbk will prompt for user input on
every connection attempt.
*ssh_user* <username>:: *ssh_user* <username>|no::
Remote username for ssh. Defaults to ``root''. Make sure the Remote username for ssh. Defaults to ``root''. Make sure the
remote user is able to run "btrfs" with root privileges (see remote user is able to run "btrfs" with root privileges (see
option 'backend' for details). option 'backend' for details). If set to ``no'', the ssh default
is used.
*ssh_compression* yes|no:: *ssh_compression* yes|no::
Enables or disables the compression of ssh connections. Defaults Enables or disables the compression of ssh connections. Defaults