NAME
API::Docker::Type::ContainerConfig - Configuration for a container that is portable between hosts
VERSION
version 0.004
DESCRIPTION
Generated from the ContainerConfig definition of spec/v1.51.yaml.
hostname
The hostname to use for the container, as a valid RFC 1123 hostname.
domainname
The domain name to use for the container.
user
Commands run as this user inside the container. If omitted, commands run as the user specified in the image the container was started from.
Can be either user-name or UID, and optional group-name or GID, separated by a colon (<user-name|UID>[<:group-name|GID>]).
attach_stdin
Whether to attach to stdin. The daemon defaults it to false.
attach_stdout
Whether to attach to stdout. The daemon defaults it to true.
attach_stderr
Whether to attach to stderr. The daemon defaults it to true.
exposed_ports
An object mapping ports to an empty object in the form:
{"<port>/<tcp|udp|sctp>": {}} The keys are the caller's data and are never translated.
tty
Attach standard streams to a TTY, including stdin if it is not closed. The daemon defaults it to false.
open_stdin
Open stdin The daemon defaults it to false.
stdin_once
Close stdin after one attached client disconnects. The daemon defaults it to false.
env
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.
cmd
Command to run specified as a string or an array of strings.
healthcheck
A test to perform to check that the container is healthy. See API::Docker::Type::HealthConfig.
args_escaped
Command is already escaped (Windows only). The daemon defaults it to false.
image
The name (or reference) of the image to use when creating the container, or which was used when the container was created.
volumes
An object mapping mount point paths inside the container to empty objects. The keys are the caller's data and are never translated.
working_dir
The working directory for commands to run in.
entrypoint
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).
network_disabled
Disable networking for the container.
mac_address
MAC address of the container.
Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead.
on_build
ONBUILD metadata that were defined in the image's Dockerfile.
labels
User-defined key/value metadata. The keys are the caller's data and are never translated.
stop_signal
Signal to stop a container as a string or unsigned integer.
stop_timeout
Timeout to stop a container in seconds. The daemon defaults it to 10.
shell
Shell for when RUN, CMD, and ENTRYPOINT uses a shell.
SUPPORT
Issues
Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.
CONTRIBUTING
Contributions are welcome! Please fork the repository and submit a pull request.
AUTHOR
Torsten Raudssus <getty@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.