diff options
author | nodiscc <nodiscc@gmail.com> | 2017-07-04 21:37:30 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-07-04 21:37:30 +0200 |
commit | 5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch) | |
tree | d5c46525f3c739d9c63de860427e0b3cadd688e5 /doc/html/Docker-101 | |
parent | d5d22a6d07917865c44148ad76f43c65a929a890 (diff) | |
parent | 8bf94136e10c64496711c8f66a4f58f89c515360 (diff) | |
download | Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.gz Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.tar.zst Shaarli-5b25a9635fe808bc1c4f3eee8cdf8485115da75d.zip |
Merge pull request #772 from nodiscc/rtfd
Generate HTML documentation using MkDocs
Diffstat (limited to 'doc/html/Docker-101')
-rw-r--r-- | doc/html/Docker-101/index.html | 398 |
1 files changed, 398 insertions, 0 deletions
diff --git a/doc/html/Docker-101/index.html b/doc/html/Docker-101/index.html new file mode 100644 index 00000000..31e57b59 --- /dev/null +++ b/doc/html/Docker-101/index.html | |||
@@ -0,0 +1,398 @@ | |||
1 | <!DOCTYPE html> | ||
2 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> | ||
3 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> | ||
4 | <head> | ||
5 | <meta charset="utf-8"> | ||
6 | <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
7 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
8 | |||
9 | |||
10 | <link rel="shortcut icon" href="../img/favicon.ico"> | ||
11 | <title>Docker 101 - Shaarli Documentation</title> | ||
12 | <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> | ||
13 | |||
14 | <link rel="stylesheet" href="../css/theme.css" type="text/css" /> | ||
15 | <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" /> | ||
16 | <link rel="stylesheet" href="../css/highlight.css"> | ||
17 | <link href="../github-markdown.css" rel="stylesheet"> | ||
18 | |||
19 | <script> | ||
20 | // Current page data | ||
21 | var mkdocs_page_name = "Docker 101"; | ||
22 | var mkdocs_page_input_path = "Docker-101.md"; | ||
23 | var mkdocs_page_url = "/Docker-101/"; | ||
24 | </script> | ||
25 | |||
26 | <script src="../js/jquery-2.1.1.min.js"></script> | ||
27 | <script src="../js/modernizr-2.8.3.min.js"></script> | ||
28 | <script type="text/javascript" src="../js/highlight.pack.js"></script> | ||
29 | |||
30 | </head> | ||
31 | |||
32 | <body class="wy-body-for-nav" role="document"> | ||
33 | |||
34 | <div class="wy-grid-for-nav"> | ||
35 | |||
36 | |||
37 | <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> | ||
38 | <div class="wy-side-nav-search"> | ||
39 | <a href=".." class="icon icon-home"> Shaarli Documentation</a> | ||
40 | <div role="search"> | ||
41 | <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> | ||
42 | <input type="text" name="q" placeholder="Search docs" /> | ||
43 | </form> | ||
44 | </div> | ||
45 | </div> | ||
46 | |||
47 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||
48 | <ul class="current"> | ||
49 | |||
50 | |||
51 | <li class="toctree-l1"> | ||
52 | |||
53 | <a class="" href="..">Home</a> | ||
54 | </li> | ||
55 | |||
56 | <li class="toctree-l1"> | ||
57 | |||
58 | <span class="caption-text">Setup</span> | ||
59 | <ul class="subnav"> | ||
60 | <li class=""> | ||
61 | |||
62 | <a class="" href="../Download-and-Installation/">Download and Installation</a> | ||
63 | </li> | ||
64 | <li class=""> | ||
65 | |||
66 | <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a> | ||
67 | </li> | ||
68 | <li class=""> | ||
69 | |||
70 | <a class="" href="../Server-requirements/">Server requirements</a> | ||
71 | </li> | ||
72 | <li class=""> | ||
73 | |||
74 | <a class="" href="../Server-configuration/">Server configuration</a> | ||
75 | </li> | ||
76 | <li class=""> | ||
77 | |||
78 | <a class="" href="../Server-security/">Server security</a> | ||
79 | </li> | ||
80 | <li class=""> | ||
81 | |||
82 | <a class="" href="../Shaarli-configuration/">Shaarli configuration</a> | ||
83 | </li> | ||
84 | <li class=""> | ||
85 | |||
86 | <a class="" href="../Plugins/">Plugins</a> | ||
87 | </li> | ||
88 | </ul> | ||
89 | </li> | ||
90 | |||
91 | <li class="toctree-l1"> | ||
92 | |||
93 | <span class="caption-text">Docker</span> | ||
94 | <ul class="subnav"> | ||
95 | <li class=" current"> | ||
96 | |||
97 | <a class="current" href="./">Docker 101</a> | ||
98 | <ul class="subnav"> | ||
99 | |||
100 | <li class="toctree-l3"><a href="#basics">Basics</a></li> | ||
101 | |||
102 | <ul> | ||
103 | |||
104 | <li><a class="toctree-l4" href="#search-an-image-on-dockerhub">Search an image on DockerHub</a></li> | ||
105 | |||
106 | <li><a class="toctree-l4" href="#show-available-tags-for-a-repository">Show available tags for a repository</a></li> | ||
107 | |||
108 | <li><a class="toctree-l4" href="#pull-an-image-from-dockerhub">Pull an image from DockerHub</a></li> | ||
109 | |||
110 | </ul> | ||
111 | |||
112 | |||
113 | </ul> | ||
114 | </li> | ||
115 | <li class=""> | ||
116 | |||
117 | <a class="" href="../Shaarli-images/">Shaarli images</a> | ||
118 | </li> | ||
119 | <li class=""> | ||
120 | |||
121 | <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
122 | </li> | ||
123 | <li class=""> | ||
124 | |||
125 | <a class="" href="../Docker-resources/">Docker resources</a> | ||
126 | </li> | ||
127 | </ul> | ||
128 | </li> | ||
129 | |||
130 | <li class="toctree-l1"> | ||
131 | |||
132 | <span class="caption-text">Usage</span> | ||
133 | <ul class="subnav"> | ||
134 | <li class=""> | ||
135 | |||
136 | <a class="" href="../Features/">Features</a> | ||
137 | </li> | ||
138 | <li class=""> | ||
139 | |||
140 | <a class="" href="../Bookmarklet/">Bookmarklet</a> | ||
141 | </li> | ||
142 | <li class=""> | ||
143 | |||
144 | <a class="" href="../Browsing-and-searching/">Browsing and searching</a> | ||
145 | </li> | ||
146 | <li class=""> | ||
147 | |||
148 | <a class="" href="../Firefox-share/">Firefox share</a> | ||
149 | </li> | ||
150 | <li class=""> | ||
151 | |||
152 | <a class="" href="../RSS-feeds/">RSS feeds</a> | ||
153 | </li> | ||
154 | <li class=""> | ||
155 | |||
156 | <a class="" href="../REST-API/">REST API</a> | ||
157 | </li> | ||
158 | </ul> | ||
159 | </li> | ||
160 | |||
161 | <li class="toctree-l1"> | ||
162 | |||
163 | <span class="caption-text">How To</span> | ||
164 | <ul class="subnav"> | ||
165 | <li class=""> | ||
166 | |||
167 | <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
168 | </li> | ||
169 | <li class=""> | ||
170 | |||
171 | <a class="" href="../Various-hacks/">Various hacks</a> | ||
172 | </li> | ||
173 | </ul> | ||
174 | </li> | ||
175 | |||
176 | <li class="toctree-l1"> | ||
177 | |||
178 | <a class="" href="../Troubleshooting/">Troubleshooting</a> | ||
179 | </li> | ||
180 | |||
181 | <li class="toctree-l1"> | ||
182 | |||
183 | <span class="caption-text">Development</span> | ||
184 | <ul class="subnav"> | ||
185 | <li class=""> | ||
186 | |||
187 | <a class="" href="../Development-guidelines/">Development guidelines</a> | ||
188 | </li> | ||
189 | <li class=""> | ||
190 | |||
191 | <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a> | ||
192 | </li> | ||
193 | <li class=""> | ||
194 | |||
195 | <a class="" href="../GnuPG-signature/">GnuPG signature</a> | ||
196 | </li> | ||
197 | <li class=""> | ||
198 | |||
199 | <a class="" href="../Coding-guidelines/">Coding guidelines</a> | ||
200 | </li> | ||
201 | <li class=""> | ||
202 | |||
203 | <a class="" href="../Directory-structure/">Directory structure</a> | ||
204 | </li> | ||
205 | <li class=""> | ||
206 | |||
207 | <a class="" href="../3rd-party-libraries/">3rd party libraries</a> | ||
208 | </li> | ||
209 | <li class=""> | ||
210 | |||
211 | <a class="" href="../Plugin-System/">Plugin System</a> | ||
212 | </li> | ||
213 | <li class=""> | ||
214 | |||
215 | <a class="" href="../Release-Shaarli/">Release Shaarli</a> | ||
216 | </li> | ||
217 | <li class=""> | ||
218 | |||
219 | <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a> | ||
220 | </li> | ||
221 | <li class=""> | ||
222 | |||
223 | <a class="" href="../Security/">Security</a> | ||
224 | </li> | ||
225 | <li class=""> | ||
226 | |||
227 | <a class="" href="../Static-analysis/">Static analysis</a> | ||
228 | </li> | ||
229 | <li class=""> | ||
230 | |||
231 | <a class="" href="../Theming/">Theming</a> | ||
232 | </li> | ||
233 | <li class=""> | ||
234 | |||
235 | <a class="" href="../Unit-tests/">Unit tests</a> | ||
236 | </li> | ||
237 | </ul> | ||
238 | </li> | ||
239 | |||
240 | <li class="toctree-l1"> | ||
241 | |||
242 | <span class="caption-text">About</span> | ||
243 | <ul class="subnav"> | ||
244 | <li class=""> | ||
245 | |||
246 | <a class="" href="../FAQ/">FAQ</a> | ||
247 | </li> | ||
248 | <li class=""> | ||
249 | |||
250 | <a class="" href="../Community-&-Related-software/">Community & Related software</a> | ||
251 | </li> | ||
252 | </ul> | ||
253 | </li> | ||
254 | |||
255 | </ul> | ||
256 | </div> | ||
257 | | ||
258 | </nav> | ||
259 | |||
260 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
261 | |||
262 | |||
263 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
264 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
265 | <a href="..">Shaarli Documentation</a> | ||
266 | </nav> | ||
267 | |||
268 | |||
269 | <div class="wy-nav-content"> | ||
270 | <div class="rst-content"> | ||
271 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
272 | <ul class="wy-breadcrumbs"> | ||
273 | <li><a href="..">Docs</a> »</li> | ||
274 | |||
275 | |||
276 | |||
277 | <li>Docker »</li> | ||
278 | |||
279 | |||
280 | |||
281 | <li>Docker 101</li> | ||
282 | <li class="wy-breadcrumbs-aside"> | ||
283 | |||
284 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Docker-101.md" | ||
285 | class="icon icon-github"> Edit on GitHub</a> | ||
286 | |||
287 | </li> | ||
288 | </ul> | ||
289 | <hr/> | ||
290 | </div> | ||
291 | <div role="main"> | ||
292 | <div class="section"> | ||
293 | |||
294 | <h2 id="basics">Basics</h2> | ||
295 | <p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant | ||
296 | to your OS / distribution, and start the service.</p> | ||
297 | <h3 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a></h3> | ||
298 | <pre><code class="bash">$ docker search debian | ||
299 | |||
300 | NAME DESCRIPTION STARS OFFICIAL AUTOMATED | ||
301 | ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK] | ||
302 | debian Debian is a Linux distribution that's comp... 603 [OK] | ||
303 | google/debian 47 [OK] | ||
304 | </code></pre> | ||
305 | |||
306 | <h3 id="show-available-tags-for-a-repository">Show available tags for a repository</h3> | ||
307 | <pre><code class="bash">$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool | ||
308 | |||
309 | % Total % Received % Xferd Average Speed Time Time Time Current | ||
310 | Dload Upload Total Spent Left Speed | ||
311 | 100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433 | ||
312 | </code></pre> | ||
313 | |||
314 | <p>Sample output:</p> | ||
315 | <pre><code class="json">[ | ||
316 | { | ||
317 | "layer": "85a02782", | ||
318 | "name": "stretch" | ||
319 | }, | ||
320 | { | ||
321 | "layer": "59abecbc", | ||
322 | "name": "testing" | ||
323 | }, | ||
324 | { | ||
325 | "layer": "bf0fd686", | ||
326 | "name": "unstable" | ||
327 | }, | ||
328 | { | ||
329 | "layer": "60c52dbe", | ||
330 | "name": "wheezy" | ||
331 | }, | ||
332 | { | ||
333 | "layer": "c5b806fe", | ||
334 | "name": "wheezy-backports" | ||
335 | } | ||
336 | ] | ||
337 | |||
338 | </code></pre> | ||
339 | |||
340 | <h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3> | ||
341 | <pre><code class="bash">$ docker pull repository[:tag] | ||
342 | |||
343 | $ docker pull debian:wheezy | ||
344 | wheezy: Pulling from debian | ||
345 | 4c8cbfd2973e: Pull complete | ||
346 | 60c52dbe9d91: Pull complete | ||
347 | Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe | ||
348 | Status: Downloaded newer image for debian:wheezy | ||
349 | </code></pre> | ||
350 | |||
351 | </div> | ||
352 | </div> | ||
353 | <footer> | ||
354 | |||
355 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
356 | |||
357 | <a href="../Shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
358 | |||
359 | |||
360 | <a href="../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
361 | |||
362 | </div> | ||
363 | |||
364 | |||
365 | <hr/> | ||
366 | |||
367 | <div role="contentinfo"> | ||
368 | <!-- Copyright etc --> | ||
369 | |||
370 | </div> | ||
371 | |||
372 | Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
373 | </footer> | ||
374 | |||
375 | </div> | ||
376 | </div> | ||
377 | |||
378 | </section> | ||
379 | |||
380 | </div> | ||
381 | |||
382 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
383 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
384 | |||
385 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
386 | |||
387 | |||
388 | <span><a href="../Plugins/" style="color: #fcfcfc;">« Previous</a></span> | ||
389 | |||
390 | |||
391 | <span style="margin-left: 15px"><a href="../Shaarli-images/" style="color: #fcfcfc">Next »</a></span> | ||
392 | |||
393 | </span> | ||
394 | </div> | ||
395 | <script src="../js/theme.js"></script> | ||
396 | |||
397 | </body> | ||
398 | </html> | ||