Type Alias: ImageConfig ​
ImageConfig:
object
Configuration of the image. These fields are used as defaults when starting a container from the image.
Type declaration ​
| Name | Type | Description |
|---|---|---|
ArgsEscaped? | boolean | null | Command is already escaped (Windows only) |
AttachStderr? | boolean | Whether to attach to stderr. |
AttachStdin? | boolean | Whether to attach to stdin. |
AttachStdout? | boolean | Whether to attach to stdout. |
Cmd? | string[] | Command to run specified as a string or an array of strings. |
Domainname? | string | The domain name to use for the container. > Deprecated: this field is not part of the image specification and is > always empty. It must not be used, and will be removed in API v1.48. |
Entrypoint? | string[] | The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string ([""]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Dockerfile). |
Env? | string[] | A list of environment variables to set inside the container in the form ["VAR=value", ...]. A variable without = is removed from the environment, rather than to have an empty value. |
ExposedPorts? | object | null | An object mapping ports to an empty object in the form: {"<port>/<tcp|udp|sctp>": {}} |
Healthcheck? | HealthConfig | - |
Hostname? | string | The hostname to use for the container, as a valid RFC 1123 hostname. > Deprecated: this field is not part of the image specification and is > always empty. It must not be used, and will be removed in API v1.48. |
Image? | string | The name (or reference) of the image to use when creating the container, or which was used when the container was created. |
Labels? | object | User-defined key/value metadata. |
MacAddress? | string | null | MAC address of the container. |
NetworkDisabled? | boolean | null | Disable networking for the container. |
OnBuild? | string[] | null | ONBUILD metadata that were defined in the image's Dockerfile. |
OpenStdin? | boolean | Open stdin |
Shell? | string[] | null | Shell for when RUN, CMD, and ENTRYPOINT uses a shell. |
StdinOnce? | boolean | Close stdin after one attached client disconnects. |
StopSignal? | string | null | Signal to stop a container as a string or unsigned integer. |
StopTimeout? | number | null | Timeout to stop a container in seconds. |
Tty? | boolean | Attach standard streams to a TTY, including stdin if it is not closed. |
User? | string | The user that commands are run as inside the container. |
Volumes? | object | An object mapping mount point paths inside the container to empty objects. |
WorkingDir? | string | The working directory for commands to run in. |