lowel/docker-api-php-sdk

Docker Engine API PHP SDK

Maintainers

Details

github.com/1ovve1/docker-api-php-sdk

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

1.1.0 2024-06-03 11:59 UTC

Requires

Requires (Dev)

MIT bb0cf97bdd19c6353307ebad5161895dc4432353

  • Andrey Bulavskiy <10vvvvvv31.woop@gmail.com>

This package is auto-updated.

Last update: 2025-03-31 13:48:26 UTC

README

Installation

Current library was tested on docker 1.41 api version!

composer require lowel/docker-api-php-sdk

Supported clients

SDK support:

  • Manual PSR-7 client;
  • Manual response handler, that return DTO objects (looks Lowel\Docker\Response\DTO) instead of ResponseInterface and throw some of the custom exceptions from Lowel\Docker\Exceptions;
  • Async client, based on Guzzle library, return promises;
  • Async response handler, same as manual response handler, but return type is promises.

You can init all clients use Lowel\Docker\ClientFactory:

$clientFactory = new \Lowel\Docker\ClientFactory();

$client = $clientFactory->getClient();
$clientWithHandler = $clientFactory->getClientWithHandler();
$asyncClient = $clientFactory->getAsyncClient();
$asyncClientWithHandler = $clientFactory->getAsyncClientWithHandler();

$client->containerList();
$clientWithHandler->containerInspect('container-name');
$asyncClient->containerStart('container-name');
$asyncClientWithHandler->containerStop('container-name');

$asyncClient->wait();
$asyncClientWithHandler->wait();

Configuration

You can switch default docker api version by set DOCKER_API_VERSION global env:

// Client factory use default value '1.41v'
$_ENV['DOCKER_API_VERSION'] = '1.43v'

Also you should have /var/run/docker.sock in your system. This is default path for docker socker.