API-Docker

 view release on metacpan or  search on metacpan

lib/API/Docker/Type/ContainerConfig.pm  view on Meta::CPAN


Command to run specified as a string or an array of strings.

=head2 healthcheck

A test to perform to check that the container is healthy. See
L<API::Docker::Type::HealthConfig>.

=head2 args_escaped

Command is already escaped (Windows only). The daemon defaults it to false.

=head2 image

The name (or reference) of the image to use when creating the container, or
which was used when the container was created.

=head2 volumes

An object mapping mount point paths inside the container to empty objects.
B<The keys are the caller's data> and are never translated.

=head2 working_dir

The working directory for commands to run in.

=head2 entrypoint

The entry point for the container as a string or an array of strings.

If the array consists of exactly one empty string (C<[""]>) then the entry
point is reset to system default (i.e., the entry point used by docker when
there is no C<ENTRYPOINT> instruction in the C<Dockerfile>).

=head2 network_disabled

Disable networking for the container.

=head2 mac_address

MAC address of the container.

Deprecated: this field is deprecated in API v1.44 and up. Use
EndpointSettings.MacAddress instead.

=head2 on_build

C<ONBUILD> metadata that were defined in the image's C<Dockerfile>.

=head2 labels

User-defined key/value metadata. B<The keys are the caller's data> and are
never translated.

=head2 stop_signal

Signal to stop a container as a string or unsigned integer.

=head2 stop_timeout

Timeout to stop a container in seconds. The daemon defaults it to 10.

=head2 shell

Shell for when C<RUN>, C<CMD>, and C<ENTRYPOINT> uses a shell.

=head1 SUPPORT

=head2 Issues

Please report bugs and feature requests at
L<https://github.com/Getty/p5-api-docker/issues>.

=head1 CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

=head1 AUTHOR

Torsten Raudssus <getty@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> L<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.

=cut



( run in 4.188 seconds using v1.01-cache-2.11-cpan-234fa220139 )