Skip to content

Commit

Permalink
GUACAMOLE-1290: Document SFTP public key parameter and correct SSH pu…
Browse files Browse the repository at this point in the history
…blic key documentation.
  • Loading branch information
necouchman committed Aug 27, 2024
1 parent d362ef6 commit 49be92e
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions src/configuring-guacamole.md
Original file line number Diff line number Diff line change
Expand Up @@ -1712,9 +1712,12 @@ by prompting the user directly.

`public-key`
: If SSH is using certificate-based authentication, this field allows
you to provide the Base64-encoded CA certificate that will be used
to validate the certificate of the user. This parameter is optional
and there is no default value.
you to provide the Base64-encoded public key rather than having it
extracted from the provided private key. This parameter is optional
and there is no default value. If a value is provided it will take
precendence, requiring that the private key match the provided
public key, and a mis-match will result in a failure to authenticate
using the provided private key.

(ssh-command)=

Expand Down Expand Up @@ -2185,6 +2188,15 @@ transfer features.
authentication. This parameter is not needed if the private key does not
require a passphrase.

`sftp-public-key`
: If the SFTP connection is using key-based authentication, this field
allows you to specify the Base64-encoded public key rather than having
it extracted from the provided private key. This parameter is optional
and there is no default value. If a value is provided it will take
precendence, requiring that the private key match the provided
public key, and a mis-match will result in a failure to authenticate
using the provided private key.

`sftp-directory`
: The directory to upload files to if they are simply dragged and dropped,
and thus otherwise lack a specific upload location. This parameter is
Expand Down

0 comments on commit 49be92e

Please sign in to comment.