Browse code

Docs: articles/https minor amendments and update

This commit proposes some minor amendments and updates
for the articles/https.md document to fix certain errors, inc.:

- Marking commands / flags as code (e.g. `tlsverify`) [done before rebase]
- Capitalising the word Docker
- Normalizing headers to match the rest of the docs;
- Expanding the page description to match the page title and the content;
- Capitalizing HTTPS etc.;
- Some spelling error fixes;
- Line-length adjustments to make it easier to read the raw file.

It does not propose any fundemental changes to the structure of the document.
Certain changes were based before another update on this doc.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)

O.S. Tezer authored on 2014/07/30 23:58:24
Showing 1 changed files
... ...
@@ -1,6 +1,6 @@
1
-page_title: Docker HTTPS Setup
2
-page_description: How to set Docker up with https
3
-page_keywords: docker, example, https, daemon
1
+page_title: Running Docker with HTTPS
2
+page_description: How to setup and run Docker with HTTPS
3
+page_keywords: docker, docs, article, example, https, daemon, tls, ca, certificate
4 4
 
5 5
 # Running Docker with https
6 6
 
... ...
@@ -11,9 +11,9 @@ If you need Docker to be reachable via the network in a safe manner, you can
11 11
 enable TLS by specifying the `tlsverify` flag and pointing Docker's
12 12
 `tlscacert` flag to a trusted CA certificate.
13 13
 
14
-In daemon mode, it will only allow connections from clients
15
-authenticated by a certificate signed by that CA. In client mode, it
16
-will only connect to servers with a certificate signed by that CA.
14
+In the daemon mode, it will only allow connections from clients
15
+authenticated by a certificate signed by that CA. In the client mode,
16
+it will only connect to servers with a certificate signed by that CA.
17 17
 
18 18
 > **Warning**: 
19 19
 > Using TLS and managing a CA is an advanced topic. Please familiarize yourself
... ...
@@ -82,24 +82,24 @@ need to provide your client keys, certificates and trusted CA:
82 82
 > Docker over TLS should run on TCP port 2376.
83 83
 
84 84
 > **Warning**: 
85
-> As shown in the example above, you don't have to run the `docker` client 
86
-> with `sudo` or the `docker` group when you use certificate
87
-> authentication. That means anyone with the keys can give any
88
-> instructions to your Docker daemon, giving them root access to the
89
-> machine hosting the daemon. Guard these keys as you would a root
90
-> password!
85
+> As shown in the example above, you don't have to run the `docker` client
86
+> with `sudo` or the `docker` group when you use certificate authentication.
87
+> That means anyone with the keys can give any instructions to your Docker
88
+> daemon, giving them root access to the machine hosting the daemon. Guard
89
+> these keys as you would a root password!
91 90
 
92
-## Secure By Default
91
+## Secure by default
93 92
 
94
-If you want to secure your Docker client connections by default, you can move the files
95
-to the `.docker` directory in your home directory. Set the `DOCKER_HOST` variable as well.
93
+If you want to secure your Docker client connections by default, you can move 
94
+the files to the `.docker` directory in your home directory - and set the
95
+`DOCKER_HOST` variable as well.
96 96
 
97 97
     $ cp ca.pem ~/.docker/ca.pem
98 98
     $ cp client-cert.pem ~/.docker/cert.pem
99 99
     $ cp client-key.pem ~/.docker/key.pem
100 100
     $ export DOCKER_HOST=tcp://:2376
101 101
 
102
-Then you can just run docker with the `--tlsverify` option.
102
+Then you can just run Docker with the `--tlsverify` option.
103 103
 
104 104
     $ docker --tlsverify ps
105 105
 
... ...
@@ -122,10 +122,10 @@ Docker in various other modes by mixing the flags.
122 122
  - `tlsverify`, `tlscacert`, `tlscert`, `tlskey`: Authenticate with client
123 123
    certificate and authenticate server based on given CA
124 124
 
125
-The client will send its client certificate if found, so you just need
126
-to drop your keys into `~/.docker/<ca, cert or key>.pem`. Alternatively, if you
127
-want to store your keys in another location, you can specify that location
128
-using the environment variable `DOCKER_CONFIG`.
125
+If found, the client will send its client certificate, so you just need
126
+to drop your keys into `~/.docker/<ca, cert or key>.pem`. Alternatively,
127
+if you want to store your keys in another location, you can specify that
128
+location using the environment variable `DOCKER_CONFIG`.
129 129
 
130 130
     $ export DOCKER_CONFIG=${HOME}/.dockers/zone1/
131 131
     $ docker --tlsverify ps