xpipe/lang/proc/texts/sshOptions_en.md
2024-04-13 16:23:09 +00:00

1.6 KiB

SSH configurations

Here you can specify any SSH options that should be passed to the connection. While some options are essentially required to successfully establish a connection, such as HostName, many other options are purely optional.

To get an overview over all possible options, you can use man ssh_config or read this guide. The exact amount of supported options purely depends on your installed SSH client.

Formatting

The content here is equivalent to one host section in an SSH config file. Note that you don't have to explicitly define the Host key, as that will be done automatically.

If you intend to define more than one host section, e.g. with dependent connections such as a proxy jump host that depends on another config host, you can define multiple host entries in here as well. XPipe will then launch the first host entry.

You don't have to perform any formatting with whitespace or indentation, this is not needed for it to function.

Note that you must take care of quoting any values if they contain spaces, otherwise they will be passed incorrectly.

Identity files

Note that you can also specify an IdentityFile option in here. If this option is specified in here, any otherwise specified key-based authentication option later down below will be ignored.

If you choose to refer to an identity file that is managed in the XPipe git vault, you can do so as well. XPipe will detect shared identity files and automatically adapt the file path on every system you cloned the git vault on.