Browse code

update docs for new install script

Signed-off-by: Jessica Frazelle <princess@docker.com>

Jessica Frazelle authored on 2015/07/16 06:01:04
Showing 7 changed files
... ...
@@ -51,10 +51,10 @@ The Docker installation configuration is equivalent to running:
51 51
 ```
52 52
 apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys\
53 53
 36A1D7869245C8950F966E92D8576A8BA88D21E9
54
-sh -c "echo deb https://get.docker.com/ubuntu docker main\
54
+sh -c "echo deb https://apt.dockerproject.org/repo ubuntu-trusty main\
55 55
 > /etc/apt/sources.list.d/docker.list"
56 56
 apt-get update
57
-apt-get install lxc-docker
57
+apt-get install docker-engine
58 58
 ```
59 59
 
60 60
 Ensure that your current working directory is set to the `DockerClientDSC`
... ...
@@ -41,51 +41,28 @@ packages.
41 41
 
42 42
 ## Install
43 43
 
44
-You use the same installation procedure for all versions of CentOS,
45
-only the package you install differs. There are two packages to choose from:
46
-
47
-<table>
48
-  <tr>
49
-    <th>Version</th>
50
-    <th>Package name</th>
51
-  </tr>
52
-  <tr>
53
-    <td>7.X</td>
54
-    <td>
55
-    <p>
56
-     <a href="https://get.docker.com/rpm/1.7.1/centos-7/RPMS/x86_64/docker-engine-1.7.1-1.el7.centos.x86_64.rpm">
57
-    https://get.docker.com/rpm/1.7.1/centos-7/RPMS/x86_64/docker-engine-1.7.1-1.el7.centos.x86_64.rpm</a>   
58
-    </p>
59
-    <p>
60
-     <a href="https://get.docker.com/rpm/1.7.1/centos-7/SRPMS/docker-engine-1.7.1-1.el7.centos.src.rpm">
61
-    https://get.docker.com/rpm/1.7.1/centos-7/SRPMS/docker-engine-1.7.1-1.el7.centos.src.rpm</a>   
62
-    </p>
63
-    </td>
64
-  </tr>
65
-</table>
66
-
67
-
68
-Installation procedure:
44
+There are two ways to install Docker Engine.  You can use `curl` with the  `get.docker.com` site. This method runs an installation script which installs via the `yum` package manager. Or you can install with the `yum` package manager directly yourself.
45
+
46
+### Install with the script
47
+
69 48
 
70 49
 1. Log into your machine as a user with `sudo` or `root` privileges.
71 50
 
72
-2. Make sure your existing packages are up-to-date.
51
+2. Make sure your existing yum packages are up-to-date.
73 52
 
74 53
 		$ sudo yum update
75 54
 		
76
-3. Download the Docker RPM to the current directory.
55
+3. Run the Docker installation script.
77 56
 		
78
-		$ curl -O -sSL https://get.docker.com/rpm/1.7.1/centos-7/RPMS/x86_64/docker-engine-1.7.1-1.el7.x86_64.rpm
79
-
80
-4. Use `yum` to install the package.
81
-
82
-		$ sudo yum localinstall --nogpgcheck docker-engine-1.7.1-1.el7.x86_64.rpm
57
+		$ curl -sSL https://get.docker.com/ | sh
58
+		
59
+		This script adds the `docker.repo` repository and installs Docker.
83 60
 
84
-5. Start the Docker daemon.
61
+4. Start the Docker daemon.
85 62
 
86 63
 		$ sudo service docker start
87 64
 
88
-6. Verify `docker` is installed correctly by running a test image in a container.
65
+5. Verify `docker` is installed correctly by running a test image in a container.
89 66
 
90 67
 		$ sudo docker run hello-world
91 68
 		Unable to find image 'hello-world:latest' locally
... ...
@@ -112,6 +89,39 @@ Installation procedure:
112 112
 
113 113
 		For more examples and ideas, visit:
114 114
 		 http://docs.docker.com/userguide/
115
+
116
+### Install without the script
117
+
118
+1. Log into your machine as a user with `sudo` or `root` privileges.
119
+
120
+2. Make sure your existing yum packages are up-to-date.
121
+
122
+        $ sudo yum update
123
+    
124
+3. Add the yum repo yourself.
125
+
126
+    For CentOS 7 run:
127
+
128
+        $ cat >/etc/yum.repos.d/docker.repo <<-EOF
129
+        [dockerrepo]
130
+        name=Docker Repository
131
+        baseurl=https://yum.dockerproject.org/repo/main/centos/7
132
+        enabled=1
133
+        gpgcheck=1
134
+        gpgkey=https://yum.dockerproject.org/gpg
135
+        EOF
136
+
137
+4. Install the Docker package.
138
+
139
+        $ sudo yum install docker-engine
140
+        
141
+5. Start the Docker daemon.
142
+
143
+        $ sudo service docker start
144
+
145
+6. Verify `docker` is installed correctly by running a test image in a container.
146
+
147
+        $ sudo docker run hello-world
115 148
  
116 149
 ## Create a docker group		
117 150
 
... ...
@@ -102,11 +102,11 @@ which is officially supported by Docker.
102 102
 
103 103
 To uninstall the Docker package:
104 104
 
105
-    $ sudo apt-get purge lxc-docker
105
+    $ sudo apt-get purge docker-engine
106 106
 
107 107
 To uninstall the Docker package and dependencies that are no longer needed:
108 108
 
109
-    $ sudo apt-get autoremove --purge lxc-docker
109
+    $ sudo apt-get autoremove --purge docker-engine
110 110
 
111 111
 The above commands will not remove images, containers, volumes, or user created
112 112
 configuration files on your host. If you wish to delete all images, containers,
... ...
@@ -38,85 +38,28 @@ reported kernel bugs may have already been fixed on the latest kernel packages
38 38
 
39 39
 ## Install
40 40
 
41
-You use the same installation procedure for all versions of Fedora,
42
-only the package you install differs. Choose from these packages:
43
-
44
-<style type="text/css">
45
-  .tg  {border-collapse:collapse;border-spacing:0;}
46
-   td{font-family:Arial, sans-serif;font-size:14px;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;vertical-align: top;}
47
-   th{font-family:Arial, sans-serif;font-size:14px;font-weight:normal;padding:10px 5px;border-style:solid;border-width:1px;overflow:hidden;word-break:normal;vertical-align: top;}
48
-</style>
49
-<table class="tg">
50
-  <tr>
51
-    <th>Version</th>
52
-    <th>Package name</th>
53
-  </tr>
54
-  <tr>
55
-    <td>Fedora 20</td>
56
-    <td>
57
-        <p>
58
-    <a href="https://get.docker.com/rpm/1.7.1/fedora-20/RPMS/x86_64/docker-engine-1.7.1-1.fc20.x86_64.rpm">
59
-    docker-engine-1.7.1-1.fc20.x86_64.rpm</a>
60
-        </p>
61
-        <p>
62
-    <a href="https://get.docker.com/rpm/1.7.1/fedora-20/SRPMS/docker-engine-1.7.1-1.fc20.src.rpm">
63
-   docker-engine-1.7.1-1.fc20.src.rpm</a>
64
-        </p>
65
-    </td>
66
-  </tr>
67
-  <tr>
68
-    <td>Fedora 21</td>
69
-    <td>
70
-    <p>
71
-    <a href="https://get.docker.com/rpm/1.7.1/fedora-21/RPMS/x86_64/docker-engine-1.7.1-1.fc21.x86_64.rpm">
72
-    docker-engine-1.7.1-1.fc21.x86_64.rpm</a>
73
-        </p>
74
-        <p>
75
-    <a href="https://get.docker.com/rpm/1.7.1/fedora-21/SRPMS/docker-engine-1.7.1-1.fc21.src.rpm">
76
-  docker-engine-1.7.1-1.fc21.src.rpm</a>
77
-        </p>
78
-    </td>
79
-  </tr>
80
-   <tr>
81
-    <td>Fedora 22</td>
82
-    <td>
83
-    <p>
84
-    <a href="https://get.docker.com/rpm/1.7.1/fedora-22/RPMS/x86_64/docker-engine-1.7.1-1.fc22.x86_64.rpm">
85
-    docker-engine-1.7.1-1.fc22.x86_64.rpm</a>
86
-        </p>
87
-        <p>
88
-    <a href="https://get.docker.com/rpm/1.7.1/fedora-22/SRPMS/docker-engine-1.7.1-1.fc22.src.rpm">
89
-    docker-engine-1.7.1-1.fc22.src.rpm</a>
90
-        </p>
91
-    </td>
92
-  </tr> 
93
-</table>
94
-
95
-
96
-This procedure depicts an installation on version 21. If you are installing on
97
-20 or 22, substitute that package for your installation. 
41
+There are two ways to install Docker Engine.  You can use `curl` with the  `get.docker.com` site. This method runs an installation script which installs via the `yum` package manager. Or you can install with the `yum` package manager directly yourself.
98 42
 
99
-1. Log into your machine as a user with `sudo` or `root` privileges.
100
-
101
-2. Make sure you don't have an older version of Docker installed.
43
+### Install with the script
102 44
 
103
-		$ yum list installed | grep docker
104
-	  
105
-	If you have an older version, remove it using the `yum -y remove <packagename>` command.
106 45
 
107
-3. Download the Docker RPM to the current directory.
108
-		
109
-		$ curl -O -sSL https://url_to_package/docker-engine-1.7.1-0.1.fc21.x86_64.rpm
46
+1. Log into your machine as a user with `sudo` or `root` privileges.
110 47
 
111
-4. Use `yum` to install the package.
48
+2. Make sure your existing yum packages are up-to-date.
112 49
 
113
-		$ sudo yum localinstall --nogpgcheck docker-engine-1.7.1-0.1.fc21.x86_64.rpm
50
+		$ sudo yum update
51
+		
52
+3. Run the Docker installation script.
53
+		
54
+		$ curl -sSL https://get.docker.com/ | sh
55
+		
56
+		This script adds the `docker.repo` repository and installs Docker.
114 57
 
115
-5. Start the Docker daemon.
58
+4. Start the Docker daemon.
116 59
 
117 60
 		$ sudo service docker start
118 61
 
119
-6. Verify `docker` is installed correctly by running a test image in a container.
62
+5. Verify `docker` is installed correctly by running a test image in a container.
120 63
 
121 64
 		$ sudo docker run hello-world
122 65
 		Unable to find image 'hello-world:latest' locally
... ...
@@ -124,7 +67,7 @@ This procedure depicts an installation on version 21. If you are installing on
124 124
 		a8219747be10: Pull complete 
125 125
 		91c95931e552: Already exists 
126 126
 		hello-world:latest: The image you are pulling has been verified. Important: image verification is a tech preview feature and should not be relied on to provide security.
127
-		Digest: sha256:aa03e5d0d5553b4c3473e89c8619cf79df368babd18681cf5daeb82aab55838d
127
+		Digest: sha256:aa03e5d0d5553b4c3473e89c8619cf79df368babd1.7.1cf5daeb82aab55838d
128 128
 		Status: Downloaded newer image for hello-world:latest
129 129
 		Hello from Docker.
130 130
 		This message shows that your installation appears to be working correctly.
... ...
@@ -143,6 +86,61 @@ This procedure depicts an installation on version 21. If you are installing on
143 143
 
144 144
 		For more examples and ideas, visit:
145 145
 		 http://docs.docker.com/userguide/
146
+
147
+### Install without the script
148
+
149
+1. Log into your machine as a user with `sudo` or `root` privileges.
150
+
151
+2. Make sure your existing yum packages are up-to-date.
152
+
153
+		$ sudo yum update
154
+    
155
+3. Add the yum repo yourself.
156
+
157
+    For Fedora 20 run:
158
+
159
+        $ cat >/etc/yum.repos.d/docker.repo <<-EOF
160
+        [dockerrepo]
161
+        name=Docker Repository
162
+        baseurl=https://yum.dockerproject.org/repo/main/fedora/20
163
+        enabled=1
164
+        gpgcheck=1
165
+        gpgkey=https://yum.dockerproject.org/gpg
166
+        EOF
167
+
168
+    For Fedora 21 run:
169
+
170
+        $ cat >/etc/yum.repos.d/docker.repo <<-EOF
171
+        [dockerrepo]
172
+        name=Docker Repository
173
+        baseurl=https://yum.dockerproject.org/repo/main/fedora/21
174
+        enabled=1
175
+        gpgcheck=1
176
+        gpgkey=https://yum.dockerproject.org/gpg
177
+        EOF
178
+
179
+    For Fedora 22 run:
180
+
181
+		$ cat >/etc/yum.repos.d/docker.repo <<-EOF
182
+        [dockerrepo]
183
+        name=Docker Repository
184
+        baseurl=https://yum.dockerproject.org/repo/main/fedora/22
185
+        enabled=1
186
+        gpgcheck=1
187
+        gpgkey=https://yum.dockerproject.org/gpg
188
+        EOF
189
+
190
+4. Install the Docker package.
191
+
192
+        $ sudo yum install docker-engine
193
+        
194
+5. Start the Docker daemon.
195
+
196
+		$ sudo service docker start
197
+
198
+6. Verify `docker` is installed correctly by running a test image in a container.
199
+
200
+		$ sudo docker run hello-world
146 201
  
147 202
 ## Create a docker group		
148 203
 
... ...
@@ -35,48 +35,29 @@ mind that your system should be fully patched to fix any potential kernel bugs.
35 35
 Any reported kernel bugs may have already been fixed on the latest kernel
36 36
 packages.
37 37
 
38
-## Install
39
-
40
-You use the same installation procedure for all versions of Red Hat Enterprise,
41
-only the package you install differs.  There are two packages to choose from:
42
-
43
-<table>
44
-  <tr>
45
-    <th>Version</th>
46
-    <th>Package name</th>
47
-  </tr>
48
-  <tr>
49
-    <td>7.X</td>
50
-    <td>
51
-    <p>
52
-     <a href="https://get.docker.com/rpm/1.7.1/centos-7/RPMS/x86_64/docker-engine-1.7.1-1.el7.centos.x86_64.rpm">
53
-    https://get.docker.com/rpm/1.7.1/centos-7/RPMS/x86_64/docker-engine-1.7.1-1.el7.centos.x86_64.rpm</a>   
54
-    </p>
55
-    <p>
56
-     <a href="https://get.docker.com/rpm/1.7.1/centos-7/SRPMS/docker-engine-1.7.1-1.el7.centos.src.rpm">
57
-    https://get.docker.com/rpm/1.7.1/centos-7/SRPMS/docker-engine-1.7.1-1.el7.centos.src.rpm</a>   
58
-    </p>
59
-    </td>
60
-  </tr>
61
-</table>
62
-
63
-Installation procedure:
38
+## Install Docker Engine
64 39
 
65
-1. Log into your machine as a user with `sudo` or `root` privileges.
40
+There are two ways to install Docker Engine.  You can use `curl` with the  `get.docker.com` site. This method runs an installation script which installs via the `yum` package manager. Or you can install with the `yum` package manager directly yourself.
66 41
 
67
-2. Download the Docker RPM to the current directory.
68
-		
69
-		$ curl -O -sSL https://get.docker.com/rpm/1.7.1/centos-7/RPMS/x86_64/docker-engine-1.7.1-1.el7.x86_64.rpm
42
+### Install with the script
70 43
 
71
-3. Use `yum` to install the package.
44
+You use the same installation procedure for all versions of CentOS.
72 45
 
73
-		$ sudo yum localinstall --nogpgcheck docker-engine-1.7.1-1.el7.x86_64.rpm
46
+1. Log into your machine as a user with `sudo` or `root` privileges.
74 47
 
75
-5. Start the Docker daemon.
48
+2. Make sure your existing yum packages are up-to-date.
49
+
50
+		$ sudo yum update
51
+		
52
+3. Run the Docker installation script.
53
+		
54
+		$ curl -sSL https://get.docker.com/ | sh
55
+
56
+4. Start the Docker daemon.
76 57
 
77 58
 		$ sudo service docker start
78 59
 
79
-6. Verify `docker` is installed correctly.
60
+5. Verify `docker` is installed correctly by running a test image in a container.
80 61
 
81 62
 		$ sudo docker run hello-world
82 63
 		Unable to find image 'hello-world:latest' locally
... ...
@@ -84,7 +65,7 @@ Installation procedure:
84 84
 		a8219747be10: Pull complete 
85 85
 		91c95931e552: Already exists 
86 86
 		hello-world:latest: The image you are pulling has been verified. Important: image verification is a tech preview feature and should not be relied on to provide security.
87
-		Digest: sha256:aa03e5d0d5553b4c3473e89c8619cf79df368babd18681cf5daeb82aab55838d
87
+		Digest: sha256:aa03e5d0d5553b4c3473e89c8619cf79df368babd1.7.1cf5daeb82aab55838d
88 88
 		Status: Downloaded newer image for hello-world:latest
89 89
 		Hello from Docker.
90 90
 		This message shows that your installation appears to be working correctly.
... ...
@@ -103,6 +84,39 @@ Installation procedure:
103 103
 
104 104
 		For more examples and ideas, visit:
105 105
 		 http://docs.docker.com/userguide/
106
+		 
107
+### Install without the script
108
+
109
+1. Log into your machine as a user with `sudo` or `root` privileges.
110
+
111
+2. Make sure your existing yum packages are up-to-date.
112
+
113
+		$ sudo yum update
114
+    
115
+3. Add the yum repo yourself.
116
+
117
+    For RHEL 7 run:
118
+
119
+		$ cat >/etc/yum.repos.d/docker.repo <<-EOF
120
+        [dockerrepo]
121
+        name=Docker Repository
122
+        baseurl=https://yum.dockerproject.org/repo/main/centos/7
123
+        enabled=1
124
+        gpgcheck=1
125
+        gpgkey=https://yum.dockerproject.org/gpg
126
+        EOF
127
+
128
+4. Install the Docker package.
129
+
130
+        $ sudo yum install docker-engine
131
+        
132
+5. Start the Docker daemon.
133
+
134
+		$ sudo service docker start
135
+
136
+6. Verify `docker` is installed correctly by running a test image in a container.
137
+
138
+		$ sudo docker run hello-world
106 139
  
107 140
 ## Create a docker group		
108 141
 
... ...
@@ -347,11 +347,11 @@ To install the latest version of Docker with `wget`:
347 347
 
348 348
 To uninstall the Docker package:
349 349
 
350
-    $ sudo apt-get purge lxc-docker
350
+    $ sudo apt-get purge docker-engine
351 351
 
352 352
 To uninstall the Docker package and dependencies that are no longer needed:
353 353
 
354
-    $ sudo apt-get autoremove --purge lxc-docker
354
+    $ sudo apt-get autoremove --purge docker-engine
355 355
 
356 356
 The above commands will not remove images, containers, volumes, or user created
357 357
 configuration files on your host. If you wish to delete all images, containers,
... ...
@@ -25,8 +25,7 @@ for, so feel free to reach out to him even just to say "Hi!"
25 25
 ## Package Name
26 26
 
27 27
 If possible, your package should be called "docker". If that name is already
28
-taken, a second choice is "lxc-docker", but with the caveat that "LXC" is now an
29
-optional dependency (as noted below). Another possible choice is "docker.io".
28
+taken, a second choice is "docker-engine". Another possible choice is "docker.io".
30 29
 
31 30
 ## Official Build vs Distro Build
32 31