Initial commit

vendor/github.com/hyperhq/hypercli/docs/reference/api/README.md

@@ -0,0 +1,15 @@
+<!--[metadata]>
++++
+draft = true
++++
+<![end-metadata]-->
+
+This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:
+
+ * The remote API by which a docker node can be queried over HTTP
+ * The registry API by which a docker node can download and upload
+   images for storage and sharing
+ * The index search API by which a docker node can search the public
+   index for images to download
+ * The docker.io OAuth and accounts API which 3rd party services can
+   use to access account information

vendor/github.com/hyperhq/hypercli/docs/reference/api/docker-io_api.md

@@ -0,0 +1,16 @@
+<!--[metadata]>
++++
+draft = true
+title = "Docker Hub API"
+description = "API Documentation for the Docker Hub API"
+keywords = ["API, Docker, index, REST, documentation, Docker Hub,  registry"]
+[menu.main]
+parent = "engine_remoteapi"
+weight = 99
++++
+<![end-metadata]-->
+
+# Docker Hub API
+
+This API is deprecated as of 1.7. To view the old version, see the [Docker Hub
+API](https://docs.docker.com/v1.7/docker/reference/api/docker-io_api/) in the 1.7 documentation.

vendor/github.com/hyperhq/hypercli/docs/reference/api/docker_io_accounts_api.md

@@ -0,0 +1,277 @@
+<!--[metadata]>
++++
+title = "docker.io accounts API"
+description = "API Documentation for docker.io accounts."
+keywords = ["API, Docker, accounts, REST,  documentation"]
+[menu.main]
+parent = "engine_remoteapi"
+weight=90
++++
+<![end-metadata]-->
+
+# docker.io accounts API
+
+## Get a single user
+
+`GET /api/v1.1/users/:username/`
+
+Get profile info for the specified user.
+
+Parameters:
+
+-   **username** – username of the user whose profile info is being
+        requested.
+
+Request Headers:
+
+-   **Authorization** – required authentication credentials of
+        either type HTTP Basic or OAuth Bearer Token.
+
+Status Codes:
+
+-   **200** – success, user data returned.
+-   **401** – authentication error.
+-   **403** – permission error, authenticated user must be the user
+        whose data is being requested, OAuth access tokens must have
+        `profile_read` scope.
+-   **404** – the specified username does not exist.
+
+**Example request**:
+
+        GET /api/v1.1/users/janedoe/ HTTP/1.1
+        Host: www.docker.io
+        Accept: application/json
+        Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
+
+**Example response**:
+
+        HTTP/1.1 200 OK
+        Content-Type: application/json
+
+        {
+            "id": 2,
+            "username": "janedoe",
+            "url": "https://www.docker.io/api/v1.1/users/janedoe/",
+            "date_joined": "2014-02-12T17:58:01.431312Z",
+            "type": "User",
+            "full_name": "Jane Doe",
+            "location": "San Francisco, CA",
+            "company": "Success, Inc.",
+            "profile_url": "https://docker.io/",
+            "gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm"
+            "email": "jane.doe@example.com",
+            "is_active": true
+        }
+
+## Update a single user
+
+`PATCH /api/v1.1/users/:username/`
+
+Update profile info for the specified user.
+
+Parameters:
+
+-   **username** – username of the user whose profile info is being
+        updated.
+
+Json Parameters:
+
+-   **full_name** (*string*) – (optional) the new name of the user.
+-   **location** (*string*) – (optional) the new location.
+-   **company** (*string*) – (optional) the new company of the user.
+-   **profile_url** (*string*) – (optional) the new profile url.
+-   **gravatar_email** (*string*) – (optional) the new Gravatar
+        email address.
+
+Request Headers:
+
+-   **Authorization** – required authentication credentials of
+        either type HTTP Basic or OAuth Bearer Token.
+-   **Content-Type** – MIME Type of post data. JSON, url-encoded
+        form data, etc.
+
+Status Codes:
+
+-   **200** – success, user data updated.
+-   **400** – post data validation error.
+-   **401** – authentication error.
+-   **403** – permission error, authenticated user must be the user
+        whose data is being updated, OAuth access tokens must have
+        `profile_write` scope.
+-   **404** – the specified username does not exist.
+
+**Example request**:
+
+        PATCH /api/v1.1/users/janedoe/ HTTP/1.1
+        Host: www.docker.io
+        Accept: application/json
+        Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
+
+        {
+            "location": "Private Island",
+            "profile_url": "http://janedoe.com/",
+            "company": "Retired",
+        }
+
+**Example response**:
+
+        HTTP/1.1 200 OK
+        Content-Type: application/json
+
+        {
+            "id": 2,
+            "username": "janedoe",
+            "url": "https://www.docker.io/api/v1.1/users/janedoe/",
+            "date_joined": "2014-02-12T17:58:01.431312Z",
+            "type": "User",
+            "full_name": "Jane Doe",
+            "location": "Private Island",
+            "company": "Retired",
+            "profile_url": "http://janedoe.com/",
+            "gravatar_url": "https://secure.gravatar.com/avatar/0212b397124be4acd4e7dea9aa357.jpg?s=80&r=g&d=mm"
+            "email": "jane.doe@example.com",
+            "is_active": true
+        }
+
+## List email addresses for a user
+
+`GET /api/v1.1/users/:username/emails/`
+
+List email info for the specified user.
+
+Parameters:
+
+-   **username** – username of the user whose profile info is being
+        updated.
+
+Request Headers:
+
+-   **Authorization** – required authentication credentials of
+        either type HTTP Basic or OAuth Bearer Token
+
+Status Codes:
+
+-   **200** – success, user data updated.
+-   **401** – authentication error.
+-   **403** – permission error, authenticated user must be the user
+        whose data is being requested, OAuth access tokens must have
+        `email_read` scope.
+-   **404** – the specified username does not exist.
+
+**Example request**:
+
+        GET /api/v1.1/users/janedoe/emails/ HTTP/1.1
+        Host: www.docker.io
+        Accept: application/json
+        Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
+
+**Example response**:
+
+        HTTP/1.1 200 OK
+        Content-Type: application/json
+
+        [
+            {
+                "email": "jane.doe@example.com",
+                "verified": true,
+                "primary": true
+            }
+        ]
+
+## Add email address for a user
+
+`POST /api/v1.1/users/:username/emails/`
+
+Add a new email address to the specified user's account. The email
+address must be verified separately, a confirmation email is not
+automatically sent.
+
+Json Parameters:
+
+-   **email** (*string*) – email address to be added.
+
+Request Headers:
+
+-   **Authorization** – required authentication credentials of
+        either type HTTP Basic or OAuth Bearer Token.
+-   **Content-Type** – MIME Type of post data. JSON, url-encoded
+        form data, etc.
+
+Status Codes:
+
+-   **201** – success, new email added.
+-   **400** – data validation error.
+-   **401** – authentication error.
+-   **403** – permission error, authenticated user must be the user
+        whose data is being requested, OAuth access tokens must have
+        `email_write` scope.
+-   **404** – the specified username does not exist.
+
+**Example request**:
+
+        POST /api/v1.1/users/janedoe/emails/ HTTP/1.1
+        Host: www.docker.io
+        Accept: application/json
+        Content-Type: application/json
+        Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
+
+        {
+            "email": "jane.doe+other@example.com"
+        }
+
+**Example response**:
+
+        HTTP/1.1 201 Created
+        Content-Type: application/json
+
+        {
+            "email": "jane.doe+other@example.com",
+            "verified": false,
+            "primary": false
+        }
+
+## Delete email address for a user
+
+`DELETE /api/v1.1/users/:username/emails/`
+
+Delete an email address from the specified user's account. You
+cannot delete a user's primary email address.
+
+Json Parameters:
+
+-   **email** (*string*) – email address to be deleted.
+
+Request Headers:
+
+-   **Authorization** – required authentication credentials of
+        either type HTTP Basic or OAuth Bearer Token.
+-   **Content-Type** – MIME Type of post data. JSON, url-encoded
+        form data, etc.
+
+Status Codes:
+
+-   **204** – success, email address removed.
+-   **400** – validation error.
+-   **401** – authentication error.
+-   **403** – permission error, authenticated user must be the user
+        whose data is being requested, OAuth access tokens must have
+        `email_write` scope.
+-   **404** – the specified username or email address does not
+        exist.
+
+**Example request**:
+
+        DELETE /api/v1.1/users/janedoe/emails/ HTTP/1.1
+        Host: www.docker.io
+        Accept: application/json
+        Content-Type: application/json
+        Authorization: Bearer zAy0BxC1wDv2EuF3tGs4HrI6qJp6KoL7nM
+
+        {
+            "email": "jane.doe+other@example.com"
+        }
+
+**Example response**:
+
+        HTTP/1.1 204 NO CONTENT
+        Content-Length: 0

vendor/github.com/hyperhq/hypercli/docs/reference/api/docker_remote_api.md

@@ -0,0 +1,268 @@
+<!--[metadata]>
++++
+title = "Remote API"
+description = "API Documentation for Docker"
+keywords = ["API, Docker, rcli, REST,  documentation"]
+[menu.main]
+parent = "engine_remoteapi"
+weight=-99
++++
+<![end-metadata]-->
+
+# Docker Remote API
+
+Docker's Remote API uses an open schema model.  In this model, unknown
+properties in incoming messages are ignored. Client applications need to take
+this behavior into account to ensure they do not break when talking to newer
+Docker daemons.
+
+The API tends to be REST, but for some complex commands, like attach or pull,
+the HTTP connection is hijacked to transport STDOUT, STDIN, and STDERR.
+
+By default the Docker daemon listens on `unix:///var/run/docker.sock` and the
+client must have `root` access to interact with the daemon. If a group named
+`docker` exists on your system, `docker` applies ownership of the socket to the
+group.
+
+The current version of the API is v1.23 which means calling `/info` is the same
+as calling `/v1.23/info`. To call an older version of the API use
+`/v1.22/info`.
+
+Use the table below to find the API version for a Docker version:
+
+Docker version  | API version                        | Changes
+----------------|------------------------------------|------------------------------------------------------
+1.11.x          | [1.23](docker_remote_api_v1.23.md) | [API changes](docker_remote_api.md#v1-23-api-changes)
+1.10.x          | [1.22](docker_remote_api_v1.22.md) | [API changes](docker_remote_api.md#v1-22-api-changes)
+1.9.x           | [1.21](docker_remote_api_v1.21.md) | [API changes](docker_remote_api.md#v1-21-api-changes)
+1.8.x           | [1.20](docker_remote_api_v1.20.md) | [API changes](docker_remote_api.md#v1-20-api-changes)
+1.7.x           | [1.19](docker_remote_api_v1.19.md) | [API changes](docker_remote_api.md#v1-19-api-changes)
+1.6.x           | [1.18](docker_remote_api_v1.18.md) | [API changes](docker_remote_api.md#v1-18-api-changes)
+1.5.x           | [1.17](docker_remote_api_v1.17.md) | [API changes](docker_remote_api.md#v1-17-api-changes)
+1.4.x           | [1.16](docker_remote_api_v1.16.md) | [API changes](docker_remote_api.md#v1-16-api-changes)
+1.3.x           | [1.15](docker_remote_api_v1.15.md) | [API changes](docker_remote_api.md#v1-15-api-changes)
+1.2.x           | [1.14](docker_remote_api_v1.14.md) | [API changes](docker_remote_api.md#v1-14-api-changes)
+
+Refer to the [GitHub repository](
+https://github.com/docker/docker/tree/master/docs/reference/api) for
+older releases.
+
+## Authentication
+
+Since API version 1.2, the auth configuration is now handled client side, so the
+client has to send the `authConfig` as a `POST` in `/images/(name)/push`. The
+`authConfig`, set as the `X-Registry-Auth` header, is currently a Base64 encoded
+(JSON) string with the following structure:
+
+```
+{"username": "string", "password": "string", "email": "string",
+   "serveraddress" : "string", "auth": ""}
+```
+
+Callers should leave the `auth` empty. The `serveraddress` is a domain/ip
+without protocol. Throughout this structure, double quotes are required.
+
+## Using Docker Machine with the API
+
+If you are using `docker-machine`, the Docker daemon is on a host that
+uses an encrypted TCP socket using TLS. This means, for Docker Machine users,
+you need to add extra parameters to `curl` or `wget` when making test
+API requests, for example:
+
+```
+curl --insecure \
+     --cert $DOCKER_CERT_PATH/cert.pem \
+     --key $DOCKER_CERT_PATH/key.pem \
+     https://YOUR_VM_IP:2376/images/json
+
+wget --no-check-certificate --certificate=$DOCKER_CERT_PATH/cert.pem \
+     --private-key=$DOCKER_CERT_PATH/key.pem \
+     https://YOUR_VM_IP:2376/images/json -O - -q
+```
+
+## Docker Events
+
+The following diagram depicts the container states accessible through the API.
+
+![States](images/event_state.png)
+
+Some container-related events are not affected by container state, so they are not included in this diagram. These events are:
+
+* **export** emitted by `docker export`
+* **exec_create** emitted by `docker exec`
+* **exec_start** emitted by `docker exec` after **exec_create**
+
+Running `docker rmi` emits an **untag** event when removing an image name.  The `rmi` command may also emit **delete** events when images are deleted by ID directly or by deleting the last tag referring to the image.
+
+> **Acknowledgement**: This diagram and the accompanying text were used with the permission of Matt Good and Gilder Labs. See Matt's original blog post [Docker Events Explained](http://gliderlabs.com/blog/2015/04/14/docker-events-explained/).
+
+## Version history
+
+This section lists each version from latest to oldest.  Each listing includes a link to the full documentation set and the changes relevant in that release.
+
+### v1.23 API changes
+
+[Docker Remote API v1.23](docker_remote_api_v1.23.md) documentation
+
+* `GET /containers/json` returns the state of the container, one of `created`, `restarting`, `running`, `paused`, `exited` or `dead`.
+
+
+### v1.22 API changes
+
+[Docker Remote API v1.22](docker_remote_api_v1.22.md) documentation
+
+* `POST /container/(name)/update` updates the resources of a container.
+* `GET /containers/json` supports filter `isolation` on Windows.
+* `GET /containers/json` now returns the list of networks of containers.
+* `GET /info` Now returns `Architecture` and `OSType` fields, providing information
+  about the host architecture and operating system type that the daemon runs on.
+* `GET /networks/(name)` now returns a `Name` field for each container attached to the network.
+* `GET /version` now returns the `BuildTime` field in RFC3339Nano format to make it
+  consistent with other date/time values returned by the API.
+* `AuthConfig` now supports a `registrytoken` for token based authentication
+* `POST /containers/create` now has a 4M minimum value limit for `HostConfig.KernelMemory`
+* Pushes initiated with `POST /images/(name)/push` and pulls initiated with `POST /images/create`
+  will be cancelled if the HTTP connection making the API request is closed before
+  the push or pull completes.
+* `POST /containers/create` now allows you to set a read/write rate limit for a
+  device (in bytes per second or IO per second).
+* `GET /networks` now supports filtering by `name`, `id` and `type`.
+* `POST /containers/create` now allows you to set the static IPv4 and/or IPv6 address for the container.
+* `POST /networks/(id)/connect` now allows you to set the static IPv4 and/or IPv6 address for the container.
+* `GET /info` now includes the number of containers running, stopped, and paused.
+* `POST /networks/create` now supports restricting external access to the network by setting the `internal` field.
+* `POST /networks/(id)/disconnect` now includes a `Force` option to forcefully disconnect a container from network
+* `GET /containers/(id)/json` now returns the `NetworkID` of containers.
+* `POST /networks/create` Now supports an options field in the IPAM config that provides options
+  for custom IPAM plugins.
+* `GET /networks/{network-id}` Now returns IPAM config options for custom IPAM plugins if any
+  are available.
+* `GET /networks/<network-id>` now returns subnets info for user-defined networks.
+* `GET /info` can now return a `SystemStatus` field useful for returning additional information about applications
+  that are built on top of engine.
+
+### v1.21 API changes
+
+[Docker Remote API v1.21](docker_remote_api_v1.21.md) documentation
+
+* `GET /volumes` lists volumes from all volume drivers.
+* `POST /volumes/create` to create a volume.
+* `GET /volumes/(name)` get low-level information about a volume.
+* `DELETE /volumes/(name)` remove a volume with the specified name.
+* `VolumeDriver` was moved from `config` to `HostConfig` to make the configuration portable.
+* `GET /images/(name)/json` now returns information about an image's `RepoTags` and `RepoDigests`.
+* The `config` option now accepts the field `StopSignal`, which specifies the signal to use to kill a container.
+* `GET /containers/(id)/stats` will return networking information respectively for each interface.
+* The `HostConfig` option now includes the `DnsOptions` field to configure the container's DNS options.
+* `POST /build` now optionally takes a serialized map of build-time variables.
+* `GET /events` now includes a `timenano` field, in addition to the existing `time` field.
+* `GET /events` now supports filtering by image and container labels.
+* `GET /info` now lists engine version information and return the information of `CPUShares` and `Cpuset`.
+* `GET /containers/json` will return `ImageID` of the image used by container.
+* `POST /exec/(name)/start` will now return an HTTP 409 when the container is either stopped or paused.
+* `GET /containers/(name)/json` now accepts a `size` parameter. Setting this parameter to '1' returns container size information in the `SizeRw` and `SizeRootFs` fields.
+* `GET /containers/(name)/json` now returns a `NetworkSettings.Networks` field,
+  detailing network settings per network. This field deprecates the
+  `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`,
+  `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which
+  are still returned for backward-compatibility, but will be removed in a future version.
+* `GET /exec/(id)/json` now returns a `NetworkSettings.Networks` field,
+  detailing networksettings per network. This field deprecates the
+  `NetworkSettings.Gateway`, `NetworkSettings.IPAddress`,
+  `NetworkSettings.IPPrefixLen`, and `NetworkSettings.MacAddress` fields, which
+  are still returned for backward-compatibility, but will be removed in a future version.
+* The `HostConfig` option now includes the `OomScoreAdj` field for adjusting the
+  badness heuristic. This heuristic selects which processes the OOM killer kills
+  under out-of-memory conditions.
+
+### v1.20 API changes
+
+[Docker Remote API v1.20](docker_remote_api_v1.20.md) documentation
+
+* `GET /containers/(id)/archive` get an archive of filesystem content from a container.
+* `PUT /containers/(id)/archive` upload an archive of content to be extracted to
+an existing directory inside a container's filesystem.
+* `POST /containers/(id)/copy` is deprecated in favor of the above `archive`
+endpoint which can be used to download files and directories from a container.
+* The `hostConfig` option now accepts the field `GroupAdd`, which specifies a
+list of additional groups that the container process will run as.
+
+### v1.19 API changes
+
+[Docker Remote API v1.19](docker_remote_api_v1.19.md) documentation
+
+* When the daemon detects a version mismatch with the client, usually when
+the client is newer than the daemon, an HTTP 400 is now returned instead
+of a 404.
+* `GET /containers/(id)/stats` now accepts `stream` bool to get only one set of stats and disconnect.
+* `GET /containers/(id)/logs` now accepts a `since` timestamp parameter.
+* `GET /info` The fields `Debug`, `IPv4Forwarding`, `MemoryLimit`, and
+`SwapLimit` are now returned as boolean instead of as an int. In addition, the
+end point now returns the new boolean fields `CpuCfsPeriod`, `CpuCfsQuota`, and
+`OomKillDisable`.
+* The `hostConfig` option now accepts the fields `CpuPeriod` and `CpuQuota`
+* `POST /build` accepts `cpuperiod` and `cpuquota` options
+
+### v1.18 API changes
+
+[Docker Remote API v1.18](docker_remote_api_v1.18.md) documentation
+
+* `GET /version` now returns `Os`, `Arch` and `KernelVersion`.
+* `POST /containers/create` and `POST /containers/(id)/start`allow you to  set ulimit settings for use in the container.
+* `GET /info` now returns `SystemTime`, `HttpProxy`,`HttpsProxy` and `NoProxy`.
+* `GET /images/json` added a `RepoDigests` field to include image digest information.
+* `POST /build` can now set resource constraints for all containers created for the build.
+* `CgroupParent` can be passed in the host config to setup container cgroups under a specific cgroup.
+* `POST /build` closing the HTTP request cancels the build
+* `POST /containers/(id)/exec` includes `Warnings` field to response.
+
+### v1.17 API changes
+
+[Docker Remote API v1.17](docker_remote_api_v1.17.md) documentation
+
+* The build supports `LABEL` command. Use this to add metadata to an image. For
+example you could add data describing the content of an image. `LABEL
+"com.example.vendor"="ACME Incorporated"`
+* `POST /containers/(id)/attach` and `POST /exec/(id)/start`
+* The Docker client now hints potential proxies about connection hijacking using HTTP Upgrade headers.
+* `POST /containers/create` sets labels on container create describing the container.
+* `GET /containers/json` returns the labels associated with the containers (`Labels`).
+* `GET /containers/(id)/json` returns the list current execs associated with the
+container (`ExecIDs`). This endpoint now returns the container labels
+(`Config.Labels`).
+* `POST /containers/(id)/rename` renames a container `id` to a new name.*
+* `POST /containers/create` and `POST /containers/(id)/start` callers can pass
+`ReadonlyRootfs` in the host config to mount the container's root filesystem as
+read only.
+* `GET /containers/(id)/stats` returns a live stream of a container's resource usage statistics.
+* `GET /images/json` returns the labels associated with each image (`Labels`).
+
+
+### v1.16 API changes
+
+[Docker Remote API v1.16](docker_remote_api_v1.16.md)
+
+* `GET /info` returns the number of CPUs available on the machine (`NCPU`),
+total memory available (`MemTotal`), a user-friendly name describing the running Docker daemon (`Name`), a unique ID identifying the daemon (`ID`), and
+a list of daemon labels (`Labels`).
+* `POST /containers/create` callers can set the new container's MAC address explicitly.
+* Volumes are now initialized when the container is created.
+* `POST /containers/(id)/copy` copies data which is contained in a volume.
+
+### v1.15 API changes
+
+[Docker Remote API v1.15](docker_remote_api_v1.15.md) documentation
+
+`POST /containers/create` you can set a container's `HostConfig` when creating a
+container. Previously this was only available when starting a container.
+
+### v1.14 API changes
+
+[Docker Remote API v1.14](docker_remote_api_v1.14.md) documentation
+
+* `DELETE /containers/(id)` when using `force`, the container will be immediately killed with SIGKILL.
+* `POST /containers/(id)/start` the `HostConfig` option accepts the field `CapAdd`, which specifies a list of capabilities
+to add, and the field `CapDrop`, which specifies a list of capabilities to drop.
+* `POST /images/create` th `fromImage` and `repo` parameters support the
+`repo:tag` format. Consequently,  the `tag` parameter is now obsolete. Using the
+new format and the `tag` parameter at the same time will return an error.

vendor/github.com/hyperhq/hypercli/docs/reference/api/hub_registry_spec.md

@@ -0,0 +1,18 @@
+<!--[metadata]>
++++
+draft = true
+title = "The Docker Hub and the Registry v1"
+description = "Documentation for docker Registry and Registry API"
+keywords = ["docker, registry, api,  hub"]
+[menu.main]
+parent="smn_hub_ref"
++++
+<![end-metadata]-->
+
+# The Docker Hub and the Registry v1
+
+This API is deprecated as of 1.7. To view the old version, see the [go
+here](hub_registry_spec.md) in
+the 1.7 documentation. If you want an overview of the current features in
+Docker Hub or other image management features see the [image management
+overview](../../userguide/eng-image/image_management.md) in the current documentation set.

vendor/github.com/hyperhq/hypercli/docs/reference/api/index.md

@@ -0,0 +1,16 @@
+<!-- [metadata]>
++++
+title = "API Reference"
+description = "Reference"
+keywords = ["Engine"]
+[menu.main]
+identifier="engine_remoteapi"
+parent="engine_ref"
++++
+<![end-metadata]-->
+
+
+# API Reference
+
+* [Docker Remote API](docker_remote_api.md)
+* [Docker Remote API client libraries](remote_api_client_libraries.md)

vendor/github.com/hyperhq/hypercli/docs/reference/api/remote_api_client_libraries.md

@@ -0,0 +1,236 @@
+<!--[metadata]>
++++
+title = "Remote API client libraries"
+description = "Various client libraries available to use with the Docker remote API"
+keywords = ["API, Docker, index, registry, REST, documentation, clients, C#, Erlang, Go, Groovy, Java, JavaScript, Perl, PHP, Python, Ruby, Rust,  Scala"]
+[menu.main]
+parent="engine_remoteapi"
+weight = 90
++++
+<![end-metadata]-->
+
+# Docker Remote API client libraries
+
+These libraries have not been tested by the Docker maintainers for
+compatibility. Please file issues with the library owners. If you find
+more library implementations, please list them in Docker doc bugs and we
+will add the libraries here.
+
+<table border="1" class="docutils">
+  <colgroup>
+    <col width="24%">
+    <col width="17%">
+    <col width="48%">
+    <col width="11%">
+  </colgroup>
+  <thead valign="bottom">
+    <tr>
+      <th class="head">Language/Framework</th>
+      <th class="head">Name</th>
+      <th class="head">Repository</th>
+      <th class="head">Status</th>
+    </tr>
+  </thead>
+  <tbody valign = "top">
+    <tr>
+      <td>C#</td>
+      <td>Docker.DotNet</td>
+      <td><a class="reference external" href="https://github.com/ahmetalpbalkan/Docker.DotNet">https://github.com/ahmetalpbalkan/Docker.DotNet</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>C++</td>
+      <td>lasote/docker_client</td>
+      <td><a class="reference external" href="http://www.biicode.com/lasote/docker_client">http://www.biicode.com/lasote/docker_client (Biicode C++ dependency manager)</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Erlang</td>
+      <td>erldocker</td>
+      <td><a class="reference external" href="https://github.com/proger/erldocker">https://github.com/proger/erldocker</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Dart</td>
+      <td>bwu_docker</td>
+      <td><a class="reference external" href="https://github.com/bwu-dart/bwu_docker">https://github.com/bwu-dart/bwu_docker</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Go</td>
+      <td>engine-api</td>
+      <td><a class="reference external" href="https://github.com/docker/engine-api">https://github.com/docker/engine-api</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Go</td>
+      <td>go-dockerclient</td>
+      <td><a class="reference external" href="https://github.com/fsouza/go-dockerclient">https://github.com/fsouza/go-dockerclient</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Go</td>
+      <td>dockerclient</td>
+      <td><a class="reference external" href="https://github.com/samalba/dockerclient">https://github.com/samalba/dockerclient</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Gradle</td>
+      <td>gradle-docker-plugin</td>
+      <td><a class="reference external" href="https://github.com/gesellix/gradle-docker-plugin">https://github.com/gesellix/gradle-docker-plugin</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Groovy</td>
+      <td>docker-client</td>
+      <td><a class="reference external" href="https://github.com/gesellix/docker-client">https://github.com/gesellix/docker-client</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Haskell</td>
+      <td>docker-hs</td>
+      <td><a class="reference external" href="https://github.com/denibertovic/docker-hs">https://github.com/denibertovic/docker-hs</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>HTML (Web Components)</td>
+      <td>docker-elements</td>
+      <td><a class="reference external" href="https://github.com/kapalhq/docker-elements">https://github.com/kapalhq/docker-elements</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Java</td>
+      <td>docker-java</td>
+      <td><a class="reference external" href="https://github.com/docker-java/docker-java">https://github.com/docker-java/docker-java</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Java</td>
+      <td>docker-client</td>
+      <td><a class="reference external" href="https://github.com/spotify/docker-client">https://github.com/spotify/docker-client</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Java</td>
+      <td>jclouds-docker</td>
+      <td><a class="reference external" href="https://github.com/jclouds/jclouds-labs/tree/master/docker">https://github.com/jclouds/jclouds-labs/tree/master/docker</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Java</td>
+      <td>rx-docker-client</td>
+      <td><a class="reference external" href="https://github.com/shekhargulati/rx-docker-client">https://github.com/shekhargulati/rx-docker-client</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>JavaScript (NodeJS)</td>
+      <td>dockerode</td>
+      <td><a class="reference external" href="https://github.com/apocas/dockerode">https://github.com/apocas/dockerode</a>
+  Install via NPM: <cite>npm install dockerode</cite></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>JavaScript (NodeJS)</td>
+      <td>docker.io</td>
+      <td><a class="reference external" href="https://github.com/appersonlabs/docker.io">https://github.com/appersonlabs/docker.io</a>
+  Install via NPM: <cite>npm install docker.io</cite></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>JavaScript</td>
+      <td>docker-js</td>
+      <td><a class="reference external" href="https://github.com/dgoujard/docker-js">https://github.com/dgoujard/docker-js</a></td>
+      <td>Outdated</td>
+    </tr>
+    <tr>
+      <td>JavaScript (Angular) <strong>WebUI</strong></td>
+      <td>Albatros</td>
+      <td><a class="reference external" href="https://github.com/dcylabs/albatros">https://github.com/dcylabs/albatros</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>JavaScript (Angular) <strong>WebUI</strong></td>
+      <td>docker-cp</td>
+      <td><a class="reference external" href="https://github.com/13W/docker-cp">https://github.com/13W/docker-cp</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>JavaScript (Angular) <strong>WebUI</strong></td>
+      <td>dockerui</td>
+      <td><a class="reference external" href="https://github.com/crosbymichael/dockerui">https://github.com/crosbymichael/dockerui</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>JavaScript (Angular) <strong>WebUI</strong></td>
+      <td>dockery</td>
+      <td><a class="reference external" href="https://github.com/lexandro/dockery">https://github.com/lexandro/dockery</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Perl</td>
+      <td>Net::Docker</td>
+      <td><a class="reference external" href="https://metacpan.org/pod/Net::Docker">https://metacpan.org/pod/Net::Docker</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Perl</td>
+      <td>Eixo::Docker</td>
+      <td><a class="reference external" href="https://github.com/alambike/eixo-docker">https://github.com/alambike/eixo-docker</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>PHP</td>
+      <td>Alvine</td>
+      <td><a class="reference external" href="http://pear.alvine.io/">http://pear.alvine.io/</a> (alpha)</td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>PHP</td>
+      <td>Docker-PHP</td>
+      <td><a class="reference external" href="https://github.com/docker-php/docker-php">https://github.com/docker-php/docker-php</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Python</td>
+      <td>docker-py</td>
+      <td><a class="reference external" href="https://github.com/docker/docker-py">https://github.com/docker/docker-py</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Ruby</td>
+      <td>docker-api</td>
+      <td><a class="reference external" href="https://github.com/swipely/docker-api">https://github.com/swipely/docker-api</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Ruby</td>
+      <td>docker-client</td>
+      <td><a class="reference external" href="https://github.com/geku/docker-client">https://github.com/geku/docker-client</a></td>
+      <td>Outdated</td>
+    </tr>
+    <tr>
+      <td>Rust</td>
+      <td>docker-rust</td>
+      <td><a class="reference external" href="https://github.com/abh1nav/docker-rust">https://github.com/abh1nav/docker-rust</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Rust</td>
+      <td>shiplift</td>
+      <td><a class="reference external" href="https://github.com/softprops/shiplift">https://github.com/softprops/shiplift</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Scala</td>
+      <td>tugboat</td>
+      <td><a class="reference external" href="https://github.com/softprops/tugboat">https://github.com/softprops/tugboat</a></td>
+      <td>Active</td>
+    </tr>
+    <tr>
+      <td>Scala</td>
+      <td>reactive-docker</td>
+      <td><a class="reference external" href="https://github.com/almoehi/reactive-docker">https://github.com/almoehi/reactive-docker</a></td>
+      <td>Active</td>
+    </tr>
+  </tbody>
+</table>