NAME

API::Docker::Type::ImageConfig - Configuration of the image

VERSION

version 0.004

DESCRIPTION

Generated from the ImageConfig definition of spec/v1.51.yaml.

These fields are used as defaults when starting a container from the image.

user

The user that commands are run as inside the container.

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.

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.

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).

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.

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.