DockerSdk.ClientOptions Class Reference

Specifies where to find a Docker daemon and how the SDK should connect to it. More...

Static Public Member Functions
static ClientOptions	FromEnvironment ()
	Generates a ClientOptions object based on the local machine's environment variables. More...

Properties
X509Certificate2Collection	Certificates = new X509Certificate2Collection() [get, set]
	Gets or sets the set of certificates to use when communicating with the daemon. More...
Api.? Credentials	Credentials [get, set]
	Gets or sets the credentials to use for connecting to the Docker daemon. More...
Uri	DaemonUri = GetDefaultUri() [get, set]
	Gets or sets the Docker daemon URL to connect to. The default is localhost using a platform-appropriate transport. More...
TimeSpan	DefaultTimeout = TimeSpan.FromSeconds(60) [get, set]
	Gets or sets how long the SDK should wait for responses to messages it sends to the Docker daemon. More...
bool	UseTls = true [get, set]
	Gets or sets a value indicating whether to use TLS for communications with the daemon. Defaults to true. More...

Detailed Description

Specifies where to find a Docker daemon and how the SDK should connect to it.

See also

DockerClient

Member Function Documentation

FromEnvironment()

static ClientOptions DockerSdk.ClientOptions.FromEnvironment ( )

inlinestatic

Generates a ClientOptions object based on the local machine's environment variables.

Returns

The generated ClientOptions.

If any of the relevant environment variables are not set, the ClientOptions object will use the default value for its corresponding property. Note that the default for DaemonUri/ DOCKER_HOST is not valid for connecting to a Docker daemon.
This method uses the following environment variables:

• DOCKER_HOST: The URL for the Docker daemon to connect to. Corresponds to the DaemonUri property.
• DOCKER_CERT_PATH: A filesystem path to read certificates from. Corresponds to the Certificates property.
• DOCKER_TLS_VERIFY: If set, the connection will use TLS. Corresponds to the UseTls property.
• COMPOSER_HTTP_TIMEOUT: The communications timeout to use, in seconds. Corresponds to the DefaultTimeout property.

Property Documentation

Certificates

X509Certificate2Collection DockerSdk.ClientOptions.Certificates = new X509Certificate2Collection()

getset

Gets or sets the set of certificates to use when communicating with the daemon.

Credentials

Api.? Credentials DockerSdk.ClientOptions.Credentials

getset

Gets or sets the credentials to use for connecting to the Docker daemon.

DaemonUri

Uri DockerSdk.ClientOptions.DaemonUri = GetDefaultUri()

getset

Gets or sets the Docker daemon URL to connect to. The default is localhost using a platform-appropriate transport.

DefaultTimeout

TimeSpan DockerSdk.ClientOptions.DefaultTimeout = TimeSpan.FromSeconds(60)

getset

Gets or sets how long the SDK should wait for responses to messages it sends to the Docker daemon.

Some SDK methods override this value.

UseTls

bool DockerSdk.ClientOptions.UseTls = true

getset

Gets or sets a value indicating whether to use TLS for communications with the daemon. Defaults to true.

---

The documentation for this class was generated from the following file:

• ClientOptions.cs