Skip to content

Client

All client settings fall under [client].

[client]
log_level = "trace"

[client.launch]
bin = "/path/to/distant"

log_file

Specifies an alternative path to use when logging information while the client is running.

String representing the path to the file.

Example
[client]
log_file = "/path/to/file.log"

log_level

Specifies the log level used when logging information while the client is running.

String representing the level. [default: info] Choices are off, error, warn, info, debug, trace.

Example
[client]
log_level = "info"

api.timeout

Maximum time (in seconds) to wait for an API network request to complete before timing out where 0 indicates no timeout will occur.

Integer time in seconds. [default: 0]

Example
[client]
[client.api]
timeout = 60

api.unix_socket

Alternative unix domain socket to connect to when using a manger (Unix only).

String representing the path to the socket file.

Example
[client]
[client.api]
unix_socket = "/path/to/distant.sock"

api.windows_pipe

Alternative name for a local named Windows pipe to connect to when using a manager (Windows only).

String representing the name of the local Windows pipe.

Example
[client]
[client.api]
windows_pipe = "some_name"

connect.options

Additional options to provide, typically forwarded to the handler within the manager facilitating the connection.

String of key-value pairs separated by commas. E.g. key="value",key2="value2".

Example
[client]
[client.connect]
options = "ssh.backend=\"libssh\",value=\"123\""

launch.bin

Path to distant program on remote machine to execute via ssh; by default, this program needs to be available within PATH as specified when compiling ssh (not your login shell).

String representing the path to the distant binary.

Example
[client]
[client.launch]
bin = "/path/to/distant"

launch.bind_server

Control the IP address that the server binds to.

String describing the interface the server should bind to.

  • ssh - the server will reply from the IP address that the ssh connection came from as found in the SSH_CONNECTION environment variable. This is useful for multihomed servers.

  • any - the server will reply on the default interface and will not bind to a particular IP address. This can be useful if the connection is made through sslh or another tool that makes the SSH connection appear to come from localhost.

  • <IP> - the server will attempt to bind to the specified IP address.

Example
[client]
[client.launch]
bind_server = "192.168.1.5"

launch.args

Additional arguments to provide to the server when launching it.

String representing the additional CLI options.

Example
[client]
[client.launch]
args = "--shutdown lonely=60 --use-ipv6"

launch.options

Additional options to provide, typically forwarded to the handler within the manager facilitating the launch of a distant server.

String of key-value pairs separated by commas. E.g. key="value",key2="value2".

Example
[client]
[client.launch]
options = "ssh.backend=\"libssh\",value=\"123\""