You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Simple async/streaming access to the [Docker](https://www.docker.com/) API, built on top of [React PHP](http://reactphp.org/).
3
+
Async, event-driven access to the [Docker Engine API](https://docs.docker.com/develop/sdk/), built on top of [ReactPHP](https://reactphp.org/).
4
4
5
5
[Docker](https://www.docker.com/) is a popular open source platform
6
6
to run and share applications within isolated, lightweight containers.
7
-
The [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api_v1.15/)
7
+
The [Docker Engine API](https://docs.docker.com/develop/sdk/)
8
8
allows you to control and monitor your containers and images.
9
9
Among others, it can be used to list existing images, download new images,
10
10
execute arbitrary commands within isolated containers, stop running containers and much more.
11
+
This lightweight library provides an efficient way to work with the Docker Engine API
12
+
from within PHP. It enables you to work with its images and containers or use
13
+
its event-driven model to react to changes and events happening.
11
14
12
15
***Async execution of Actions** -
13
16
Send any number of actions (commands) to your Docker daemon in parallel and
14
17
process their responses as soon as results come in.
15
-
The Promise-based design provides a *sane* interface to working with out of bound responses.
18
+
The Promise-based design provides a *sane* interface to working with out of order responses.
16
19
***Lightweight, SOLID design** -
17
-
Provides a thin abstraction that is [*just good enough*](http://en.wikipedia.org/wiki/Principle_of_good_enough)
20
+
Provides a thin abstraction that is [*just good enough*](https://en.wikipedia.org/wiki/Principle_of_good_enough)
18
21
and does not get in your way.
19
-
This library is merely a very thin wrapper around the Remote API.
22
+
This library is merely a very thin wrapper around the [Docker Engine API](https://docs.docker.com/develop/sdk/).
20
23
***Good test coverage** -
21
24
Comes with an automated tests suite and is regularly tested in the *real world*
22
25
@@ -100,7 +103,7 @@ The recommended way to create a `Client` is using the `Factory` (see above).
100
103
101
104
#### Commands
102
105
103
-
All public methods on the `Client` resemble the API described in the [Remote API documentation](https://docs.docker.com/reference/api/docker_remote_api_v1.15/) like this:
106
+
All public methods on the `Client` resemble the API described in the [Docker Engine API documentation](https://docs.docker.com/develop/sdk/) like this:
104
107
105
108
```php
106
109
$client->containerList($all, $size);
@@ -120,7 +123,7 @@ $client->version();
120
123
```
121
124
122
125
Listing all available commands is out of scope here, please refer to the
123
-
[Remote API documentation](https://docs.docker.com/reference/api/docker_remote_api_v1.15/)
126
+
[Docker Engine API documentation](https://docs.docker.com/develop/sdk/)
124
127
or the [class outline](src/Client.php).
125
128
126
129
Each of these commands supports async operation and either *resolves* with its *results*
@@ -151,7 +154,7 @@ If this looks strange to you, you can also use the more traditional [blocking AP
151
154
As stated above, this library provides you a powerful, async API by default.
152
155
153
156
If, however, you want to integrate this into your traditional, blocking environment,
154
-
you should look into also using [clue/block-react](https://github.com/clue/php-block-react).
157
+
you should look into also using [clue/reactphp-block](https://github.com/clue/reactphp-block).
155
158
156
159
The resulting blocking code could look something like this:
157
160
@@ -183,7 +186,7 @@ $promises = array(
183
186
$inspections = Block\awaitAll($promises, $loop);
184
187
```
185
188
186
-
Please refer to [clue/block-react](https://github.com/clue/php-block-react#readme) for more details.
189
+
Please refer to [clue/reactphp-block](https://github.com/clue/reactphp-block#readme) for more details.
0 commit comments