Interface: IDockerHttpsConnectionOptions

The options of buildDockerHttpsConnectionOptions: a daemon reached over HTTPS at host and port, with the ca, cert and key (PEM contents), the headers, the timeout and the API version of IDockerConnectionOptions (its protocol is replaced by 'https').

Extends

• Omit<IDockerConnectionOptions, "socketPath" | "sshAuthAgent">

Properties

ca?

optional ca?: 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

IDockerConnectionOptions.ca

---

cert?

optional cert?: string | string[] | Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[]

The client certificate of the HTTPS connections (its PEM contents).

Default

undefined

Inherited from

IDockerConnectionOptions.cert

---

headers?

optional headers?: object

The HTTP headers added to every request sent to the daemon.

Index Signature

[name: string]: string

Default

undefined

Inherited from

IDockerConnectionOptions.headers

---

host

host: string

The host name or IP address of the daemon, as its certificate names it.

Overrides

IDockerConnectionOptions.host

---

key?

optional key?: string | string[] | Buffer<ArrayBufferLike> | Buffer<ArrayBufferLike>[] | IDockerKeyObject[]

The private key of cert (its PEM contents), or keys with their passphrases.

Default

undefined

Inherited from

IDockerConnectionOptions.key

---

port

port: string | number

The TCP port of the daemon (2376 by convention).

Overrides

IDockerConnectionOptions.port

---

protocol?

optional protocol?: "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

---

timeout?

optional timeout?: 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?

optional username?: string

The user of the SSH connections.

Default

undefined

Inherited from

IDockerConnectionOptions.username

---

version?

optional version?: string

The version of the Docker Engine API used by the requests ('1.47' or 'v1.47').

Default

undefined (negotiated with the daemon)

Inherited from

IDockerConnectionOptions.version