Commit graph

128 commits

Author SHA1 Message Date
Yong Tang
e82dcaab52 Use binary frame for websocket attach endpoint
This fix tries to address the issue raised in 28176 where
text frame was used in websocket attach endpoint. In case
the data send out contains non utf8 data, the connection
will be closed in certain browsers, e.g., Safari.

This fix address the issue by change `PayloadType` to `BinaryFrame`.

This fix is tested manually with Safari. The docker daemon is inside a Linux Virtual Machine.

Create a container with:
```
docker run -itd --name websocket busybox sh -c "while true; do echo -e 'he\\xc3\\x28o'; sleep 5; done"
```

Use the following url (172.16.66.128:2375 is the tcp address of the daemon):
```
file:///websocket.html?url=ws://172.16.66.128:2375/v1.25/containers/websocket/attach/ws?logs=1&stderr=1&stdout=1&stream=1&stdin=1
```

and the following html:
```
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Websocket</title>
  <script type="text/javascript">
    function DockerWebSocket() {
      if ("WebSocket" in window) {
        console.log("WebSocket is supported by Browser...")
        // Remove '?url=' prefix
        url = window.location.search.replace(/^(\?url=)/,"");
        console.log("URL ["+url+"]...");
        var ws = new WebSocket(url);
        ws.onopen = function() {
          console.log("Connection is opened...");
        };
        ws.onclose = function() {
          console.log("Connection is closed...");
        };
        ws.onmessage = function (e) {
          if (typeof e.data === "string") {
            alert("WebSocket received text message ["+e.data+"]!")
          } else {
            console.log("Message is received...")
            var blobReader = new FileReader();
            blobReader.onload = function(event) {
              console.log(JSON.stringify(blobReader.result))
            };
            blobReader.readAsText(e.data)
            console.log("Message complete...")
          }
        };
      } else {
        alert("WebSocket is not supported by Browser!");
      }
    }
  </script>
</head>
<body>
  <div>
    <a href="javascript:DockerWebSocket()">Run DockerWebSocket</a>
  </div>
</body>
</html>
```

This fix fixes 28176.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2017-01-31 14:04:32 -08:00
allencloud
e399c558e6 validate healthcheck params in daemon side
Signed-off-by: allencloud <allen.sun@daocloud.io>
2017-01-29 13:35:32 +08:00
Misty Stanley-Jones
05d4c1314e Merge pull request #30478 from mstanleyjones/fix_broken_links
Fix broken relative links in old API docs
2017-01-27 09:45:52 -08:00
Misty Stanley-Jones
37b13201c4 Fix broken relative links in old API docs
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-01-26 10:15:47 -08:00
Lars-Magnus Skog
9c98bffc2b update api docs on Placement.Constraints for services
Signed-off-by: Lars-Magnus Skog <ralphtheninja@riseup.net>
2017-01-26 15:01:21 +01:00
Lei Jitang
2f0d494682 typo: fix typo in api documents
Signed-off-by: Lei Jitang <leijitang@huawei.com>
2017-01-23 22:05:44 -05:00
Boaz Shuster
b1996728aa Update docs and code to use application/x-tar in the build API
At the "Build image from Dockerfile" section in the API docs
the Content-Type header is missing.
In addition, some parts in the code are still setting the
Content-Type header to application/tar while it was changed
to application/x-tar since 16th September 2015.

Signed-off-by: Boaz Shuster <ripcurld.github@gmail.com>
2017-01-10 06:40:06 +02:00
Lars-Magnus Skog
778eeaea20 Attempts -> MaxAttempts in /services/create
Signed-off-by: Lars-Magnus Skog <ralphtheninja@riseup.net>
2017-01-09 16:04:34 +01:00
David Xia
f394b1d776
Fix typo in docs
s/BlkioDeviceWiiteIOps/BlkioDeviceWriteIOps/g

Signed-off-by: David Xia <dxia@spotify.com>
2016-12-25 11:48:11 -05:00
Vincent Demeester
524704143b Merge pull request #29600 from allencloud/update-docs-about-service-update
update service update in docs
2016-12-22 15:17:51 +01:00
Brian Goff
584485abca Merge pull request #29637 from wxb0521/bo-docker-0.5
some punctuation errors and a verb form error
2016-12-21 12:18:04 -05:00
allencloud
b44efead25 update service update in docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-12-22 00:11:08 +08:00
Xinbo Weng
32996d6016 some punctuation errors and a verb form error
Signed-off-by: Xinbo Weng <xihuanbo_0521@zju.edu.cn>
2016-12-21 20:05:19 +08:00
Anran Qiao
3dc3921c76
Fix document typos
Change the `State` field of the `/containers/json` remote API response to lowercase.
This change involves docs/api/v1.23.md and docs/api/v1.24.md

Signed-off-by: Anran Qiao <anran.qiao@daocloud.io>
2016-12-21 18:28:52 +08:00
tim-zju
4bf9e7caaa spell error: in other parts, they are lower-case
Signed-off-by: tim-zju <21651152@zju.edu.cn>
2016-12-19 13:05:11 +08:00
allencloud
19654fd71e add missing status code 403 for services/create in docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-12-10 01:54:51 +08:00
Vincent Demeester
9468d687ac Merge pull request #29062 from erxian/refine-api-swagger.yaml-towards-image-create-status-code
refine api swagger.yaml towards image create status code
2016-12-07 22:03:54 +01:00
lixiaobing10051267
9c76fb253e modify URLs for bind docker in docs/api
Signed-off-by: lixiaobing10051267 <li.xiaobing1@zte.com.cn>
2016-12-07 15:06:16 +08:00
erxian
15be050fb3 refine api swagger.yaml towards image create status code
Signed-off-by: erxian <evelynhsu21@gmail.com>
2016-12-07 10:27:40 +08:00
allencloud
0d21e24b9f add 403 for endpoint network create
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-12-06 14:36:50 +08:00
allencloud
9a1f7b6b0b add missing status code in api docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-12-02 11:24:45 +08:00
Sebastiaan van Stijn
457d562af1 Merge pull request #28917 from erxian/correct-secret-remove-http-return-code
correct the http return code of secret remove
2016-11-30 22:47:28 +01:00
Sebastiaan van Stijn
643b1c0175 Merge pull request #28840 from bfirsh/2016-11-25-api-docs
Updates to swagger.yaml and API documentation
2016-11-30 15:49:25 +01:00
erxian
21768933fb correct the http return code of secret remove
Signed-off-by: erxian <evelynhsu21@gmail.com>
2016-11-30 19:45:45 +08:00
Ben Firshman
d9b109b807
Fix headings in old API docs
Jekyll automatically adds titles based on the title of the page,
so this was causing duplicate titles.

Also, made all the headings the correct level.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-11-28 11:24:22 +00:00
erxian
c22821014a update the secret command docs
Signed-off-by: erxian <evelynhsu21@gmail.com>
2016-11-23 10:36:11 +08:00
Ben Firshman
f0d55cd081
Rename Remote API to Engine API
Implementation of https://github.com/docker/docker/issues/28319

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-11-22 12:49:38 +00:00
Ben Firshman
993854f58f
Move API reference to new location
See: https://github.com/docker/docker.github.io/pull/606

Also:
- Add missing redirects to API reference pages
- Remove v1.25 and 1.26, because they are being replaced with
  swagger generated docs.
- Remove all other docs which aren't reference material, because
  this can live in docker/docker.github.io

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
2016-11-22 12:47:25 +00:00