aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Docker-101
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/html/Docker-101
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
Generate HTML documentation using MkDocs (WIP)
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
Diffstat (limited to 'doc/html/Docker-101')
-rw-r--r--doc/html/Docker-101/index.html410
1 files changed, 410 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..5b4f645c
--- /dev/null
+++ b/doc/html/Docker-101/index.html
@@ -0,0 +1,410 @@
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="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
172 </li>
173 <li class="">
174
175 <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
176 </li>
177 <li class="">
178
179 <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
180 </li>
181 <li class="">
182
183 <a class="" href="../Datastore-hacks/">Datastore hacks</a>
184 </li>
185 </ul>
186 </li>
187
188 <li class="toctree-l1">
189
190 <a class="" href="../Troubleshooting/">Troubleshooting</a>
191 </li>
192
193 <li class="toctree-l1">
194
195 <span class="caption-text">Development</span>
196 <ul class="subnav">
197 <li class="">
198
199 <a class="" href="../Development-guidelines/">Development guidelines</a>
200 </li>
201 <li class="">
202
203 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
204 </li>
205 <li class="">
206
207 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
208 </li>
209 <li class="">
210
211 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
212 </li>
213 <li class="">
214
215 <a class="" href="../Directory-structure/">Directory structure</a>
216 </li>
217 <li class="">
218
219 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
220 </li>
221 <li class="">
222
223 <a class="" href="../Plugin-System/">Plugin System</a>
224 </li>
225 <li class="">
226
227 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
228 </li>
229 <li class="">
230
231 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
232 </li>
233 <li class="">
234
235 <a class="" href="../Security/">Security</a>
236 </li>
237 <li class="">
238
239 <a class="" href="../Static-analysis/">Static analysis</a>
240 </li>
241 <li class="">
242
243 <a class="" href="../Theming/">Theming</a>
244 </li>
245 <li class="">
246
247 <a class="" href="../Unit-tests/">Unit tests</a>
248 </li>
249 </ul>
250 </li>
251
252 <li class="toctree-l1">
253
254 <span class="caption-text">About</span>
255 <ul class="subnav">
256 <li class="">
257
258 <a class="" href="../FAQ/">FAQ</a>
259 </li>
260 <li class="">
261
262 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
263 </li>
264 </ul>
265 </li>
266
267 </ul>
268 </div>
269 &nbsp;
270 </nav>
271
272 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
273
274
275 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
276 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
277 <a href="..">Shaarli Documentation</a>
278 </nav>
279
280
281 <div class="wy-nav-content">
282 <div class="rst-content">
283 <div role="navigation" aria-label="breadcrumbs navigation">
284 <ul class="wy-breadcrumbs">
285 <li><a href="..">Docs</a> &raquo;</li>
286
287
288
289 <li>Docker &raquo;</li>
290
291
292
293 <li>Docker 101</li>
294 <li class="wy-breadcrumbs-aside">
295
296 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Docker-101.md"
297 class="icon icon-github"> Edit on GitHub</a>
298
299 </li>
300 </ul>
301 <hr/>
302</div>
303 <div role="main">
304 <div class="section">
305
306 <h2 id="basics">Basics</h2>
307<p>Install <a href="https://www.docker.com/">Docker</a>, by following the instructions relevant
308to your OS / distribution, and start the service.</p>
309<h3 id="search-an-image-on-dockerhub">Search an image on <a href="https://hub.docker.com/">DockerHub</a></h3>
310<pre><code class="bash">$ docker search debian
311
312NAME DESCRIPTION STARS OFFICIAL AUTOMATED
313ubuntu Ubuntu is a Debian-based Linux operating s... 2065 [OK]
314debian Debian is a Linux distribution that's comp... 603 [OK]
315google/debian 47 [OK]
316</code></pre>
317
318<h3 id="show-available-tags-for-a-repository">Show available tags for a repository</h3>
319<pre><code class="bash">$ curl https://index.docker.io/v1/repositories/debian/tags | python -m json.tool
320
321% Total % Received % Xferd Average Speed Time Time Time Current
322Dload Upload Total Spent Left Speed
323100 1283 0 1283 0 0 433 0 --:--:-- 0:00:02 --:--:-- 433
324</code></pre>
325
326<p>Sample output:</p>
327<pre><code class="json">[
328 {
329 &quot;layer&quot;: &quot;85a02782&quot;,
330 &quot;name&quot;: &quot;stretch&quot;
331 },
332 {
333 &quot;layer&quot;: &quot;59abecbc&quot;,
334 &quot;name&quot;: &quot;testing&quot;
335 },
336 {
337 &quot;layer&quot;: &quot;bf0fd686&quot;,
338 &quot;name&quot;: &quot;unstable&quot;
339 },
340 {
341 &quot;layer&quot;: &quot;60c52dbe&quot;,
342 &quot;name&quot;: &quot;wheezy&quot;
343 },
344 {
345 &quot;layer&quot;: &quot;c5b806fe&quot;,
346 &quot;name&quot;: &quot;wheezy-backports&quot;
347 }
348]
349
350</code></pre>
351
352<h3 id="pull-an-image-from-dockerhub">Pull an image from DockerHub</h3>
353<pre><code class="bash">$ docker pull repository[:tag]
354
355$ docker pull debian:wheezy
356wheezy: Pulling from debian
3574c8cbfd2973e: Pull complete
35860c52dbe9d91: Pull complete
359Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
360Status: Downloaded newer image for debian:wheezy
361</code></pre>
362
363 </div>
364 </div>
365 <footer>
366
367 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
368
369 <a href="../Shaarli-images/" class="btn btn-neutral float-right" title="Shaarli images">Next <span class="icon icon-circle-arrow-right"></span></a>
370
371
372 <a href="../Plugins/" class="btn btn-neutral" title="Plugins"><span class="icon icon-circle-arrow-left"></span> Previous</a>
373
374 </div>
375
376
377 <hr/>
378
379 <div role="contentinfo">
380 <!-- Copyright etc -->
381
382 </div>
383
384 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>.
385</footer>
386
387 </div>
388 </div>
389
390 </section>
391
392 </div>
393
394 <div class="rst-versions" role="note" style="cursor: pointer">
395 <span class="rst-current-version" data-toggle="rst-current-version">
396
397 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
398
399
400 <span><a href="../Plugins/" style="color: #fcfcfc;">&laquo; Previous</a></span>
401
402
403 <span style="margin-left: 15px"><a href="../Shaarli-images/" style="color: #fcfcfc">Next &raquo;</a></span>
404
405 </span>
406</div>
407 <script src="../js/theme.js"></script>
408
409</body>
410</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-26 22:44:20 +0000