Interface: IDockerSocketConnectionOptions

The options of buildDockerSocketConnectionOptions: the daemon's Unix socket or named pipe (socketPath), with the authorities (ca), the timeout and the API version of IDockerConnectionOptions.

Extends

• Omit<IDockerConnectionOptions, "sshAuthAgent" | "key" | "protocol" | "cert" | "headers" | "username" | "port" | "host">

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

---

socketPath?

optional socketPath?: string

The path of the daemon's Unix socket (/var/run/docker.sock), or of its named pipe on Windows (//./pipe/docker_engine). When set, host and port are ignored.

Default

undefined (the Docker of the environment)

Inherited from

IDockerConnectionOptions.socketPath

---

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

---

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