Class DockerSettings
Specifies the configuration settings for a DockerClient.
Namespace: Neon.Docker
Assembly: Neon.Docker.dll
Syntax
public class DockerSettingsConstructors
DockerSettings(IPAddress, int, bool)
Constructs settings using an IPAddress for the Docker engine.
Declaration
public DockerSettings(IPAddress address, int port = 2375, bool secure = false)Parameters
| Type | Name | Description |
|---|---|---|
| IPAddress | address | The engine IP address. |
| int | port | Optional TCP port (defaults to Docker [2375]). |
| bool | secure | Optionally specifies that the connection will be secured via TLS (defaults to |
DockerSettings(string)
Constructs settings from a URI. Note that you may specify a Unix domain socket like: unix:///var/run/docker/sock.
Declaration
public DockerSettings(string uri)Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | The URI. |
DockerSettings(string, int, bool)
Constructs settings using a DNS hostname for the Docker engine.
Declaration
public DockerSettings(string host, int port = 2375, bool secure = false)Parameters
| Type | Name | Description |
|---|---|---|
| string | host | Engine hostname. |
| int | port | Optional TCP port (defaults to Docker [2375]). |
| bool | secure | Optionally specifies that the connection will be secured via TLS (defaults to |
Properties
RetryPolicy
The IRetryPolicy to be used when submitting requests to docker. This defaults to a reasonable ExponentialRetryPolicy using the NetworkOrHttp(Exception) transient detector.
Declaration
public IRetryPolicy RetryPolicy { get; set; }Property Value
| Type | Description |
|---|---|
| IRetryPolicy |
Uri
Returns the target engine's base URI.
Declaration
public Uri Uri { get; }Property Value
| Type | Description |
|---|---|
| Uri |
Methods
CreateClient()
Creates a DockerClient using the settings.
Declaration
public DockerClient CreateClient()Returns
| Type | Description |
|---|---|
| DockerClient | The created DockerClient. |