Interface: IDockerSSHConnectionOptions
The options of buildDockerSSHConnectionOptions: a remote host reached over SSH at host and port, as username, authenticated by the SSH agent (sshAuthAgent), with the timeout and the API version of IDockerConnectionOptions (its protocol is replaced by 'ssh').
Extends
Omit<IDockerConnectionOptions,"socketPath">
Properties
ca?
optionalca?:string|string[] |Buffer<ArrayBufferLike> |Buffer<ArrayBufferLike>[]
The certificates of the authorities trusted for the daemon's HTTPS certificate: their PEM contents, not their file paths.
Default
undefined (the authorities of Node.js)Inherited from
cert?
optionalcert?:string|string[] |Buffer<ArrayBufferLike> |Buffer<ArrayBufferLike>[]
The client certificate of the HTTPS connections (its PEM contents).
Default
undefinedInherited from
headers?
optionalheaders?:object
The HTTP headers added to every request sent to the daemon.
Index Signature
[name: string]: string
Default
undefinedInherited from
IDockerConnectionOptions.headers
host
host:
string
The host name or IP address of the remote host running the daemon.
Overrides
key?
optionalkey?:string|string[] |Buffer<ArrayBufferLike> |Buffer<ArrayBufferLike>[] |IDockerKeyObject[]
The private key of cert (its PEM contents), or keys with their passphrases.
Default
undefinedInherited from
port
port:
string|number
The SSH port of the remote host (usually 22).
Overrides
protocol?
optionalprotocol?:"https"|"http"|"ssh"
How host is reached: 'http', 'https', or 'ssh' (which needs the optional package ssh2, and the Docker CLI on the remote host). Ignored with socketPath.
Default
'https' when ca, cert and key are all given, 'http' otherwise
Inherited from
IDockerConnectionOptions.protocol
sshAuthAgent?
optionalsshAuthAgent?:string
The path of the SSH agent's socket, which authenticates the SSH connections.
Default
undefined (the SSH_AUTH_SOCK environment variable)
Inherited from
IDockerConnectionOptions.sshAuthAgent
timeout?
optionaltimeout?:number
How long a request may stay idle (no data received), in milliseconds, before it fails; the streams (followed logs) included.
Default
undefined (no timeout)Inherited from
IDockerConnectionOptions.timeout
username?
optionalusername?:string
The user of the SSH connections.
Default
undefinedInherited from
IDockerConnectionOptions.username
version?
optionalversion?:string
The version of the Docker Engine API used by the requests ('1.47' or 'v1.47').
Default
undefined (negotiated with the daemon)