aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Shaarli-images/index.html
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/Shaarli-images/index.html
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/Shaarli-images/index.html')
-rw-r--r--doc/html/Shaarli-images/index.html425
1 files changed, 425 insertions, 0 deletions
diff --git a/doc/html/Shaarli-images/index.html b/doc/html/Shaarli-images/index.html
new file mode 100644
index 00000000..0fa93ca3
--- /dev/null
+++ b/doc/html/Shaarli-images/index.html
@@ -0,0 +1,425 @@
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>Shaarli images - 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 = "Shaarli images";
22 var mkdocs_page_input_path = "Shaarli-images.md";
23 var mkdocs_page_url = "/Shaarli-images/";
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="">
96
97 <a class="" href="../Docker-101/">Docker 101</a>
98 </li>
99 <li class=" current">
100
101 <a class="current" href="./">Shaarli images</a>
102 <ul class="subnav">
103
104 <li class="toctree-l3"><a href="#get-and-run-a-shaarli-image">Get and run a Shaarli image</a></li>
105
106 <ul>
107
108 <li><a class="toctree-l4" href="#dockerhub-repository">DockerHub repository</a></li>
109
110 <li><a class="toctree-l4" href="#available-image-tags">Available image tags</a></li>
111
112 <li><a class="toctree-l4" href="#download-from-dockerhub">Download from DockerHub</a></li>
113
114 <li><a class="toctree-l4" href="#create-and-start-a-new-container-from-the-image">Create and start a new container from the image</a></li>
115
116 <li><a class="toctree-l4" href="#stop-and-destroy-a-container">Stop and destroy a container</a></li>
117
118 </ul>
119
120
121 </ul>
122 </li>
123 <li class="">
124
125 <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
126 </li>
127 <li class="">
128
129 <a class="" href="../Docker-resources/">Docker resources</a>
130 </li>
131 </ul>
132 </li>
133
134 <li class="toctree-l1">
135
136 <span class="caption-text">Usage</span>
137 <ul class="subnav">
138 <li class="">
139
140 <a class="" href="../Features/">Features</a>
141 </li>
142 <li class="">
143
144 <a class="" href="../Bookmarklet/">Bookmarklet</a>
145 </li>
146 <li class="">
147
148 <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
149 </li>
150 <li class="">
151
152 <a class="" href="../Firefox-share/">Firefox share</a>
153 </li>
154 <li class="">
155
156 <a class="" href="../RSS-feeds/">RSS feeds</a>
157 </li>
158 <li class="">
159
160 <a class="" href="../REST-API/">REST API</a>
161 </li>
162 </ul>
163 </li>
164
165 <li class="toctree-l1">
166
167 <span class="caption-text">How To</span>
168 <ul class="subnav">
169 <li class="">
170
171 <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
172 </li>
173 <li class="">
174
175 <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
176 </li>
177 <li class="">
178
179 <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
180 </li>
181 <li class="">
182
183 <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
184 </li>
185 <li class="">
186
187 <a class="" href="../Datastore-hacks/">Datastore hacks</a>
188 </li>
189 </ul>
190 </li>
191
192 <li class="toctree-l1">
193
194 <a class="" href="../Troubleshooting/">Troubleshooting</a>
195 </li>
196
197 <li class="toctree-l1">
198
199 <span class="caption-text">Development</span>
200 <ul class="subnav">
201 <li class="">
202
203 <a class="" href="../Development-guidelines/">Development guidelines</a>
204 </li>
205 <li class="">
206
207 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
208 </li>
209 <li class="">
210
211 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
212 </li>
213 <li class="">
214
215 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
216 </li>
217 <li class="">
218
219 <a class="" href="../Directory-structure/">Directory structure</a>
220 </li>
221 <li class="">
222
223 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
224 </li>
225 <li class="">
226
227 <a class="" href="../Plugin-System/">Plugin System</a>
228 </li>
229 <li class="">
230
231 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
232 </li>
233 <li class="">
234
235 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
236 </li>
237 <li class="">
238
239 <a class="" href="../Security/">Security</a>
240 </li>
241 <li class="">
242
243 <a class="" href="../Static-analysis/">Static analysis</a>
244 </li>
245 <li class="">
246
247 <a class="" href="../Theming/">Theming</a>
248 </li>
249 <li class="">
250
251 <a class="" href="../Unit-tests/">Unit tests</a>
252 </li>
253 </ul>
254 </li>
255
256 <li class="toctree-l1">
257
258 <span class="caption-text">About</span>
259 <ul class="subnav">
260 <li class="">
261
262 <a class="" href="../FAQ/">FAQ</a>
263 </li>
264 <li class="">
265
266 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
267 </li>
268 </ul>
269 </li>
270
271 </ul>
272 </div>
273 &nbsp;
274 </nav>
275
276 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
277
278
279 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
280 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
281 <a href="..">Shaarli Documentation</a>
282 </nav>
283
284
285 <div class="wy-nav-content">
286 <div class="rst-content">
287 <div role="navigation" aria-label="breadcrumbs navigation">
288 <ul class="wy-breadcrumbs">
289 <li><a href="..">Docs</a> &raquo;</li>
290
291
292
293 <li>Docker &raquo;</li>
294
295
296
297 <li>Shaarli images</li>
298 <li class="wy-breadcrumbs-aside">
299
300 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Shaarli-images.md"
301 class="icon icon-github"> Edit on GitHub</a>
302
303 </li>
304 </ul>
305 <hr/>
306</div>
307 <div role="main">
308 <div class="section">
309
310 <h2 id="get-and-run-a-shaarli-image">Get and run a Shaarli image</h2>
311<h3 id="dockerhub-repository">DockerHub repository</h3>
312<p>The images can be found in the <a href="https://hub.docker.com/r/shaarli/shaarli/"><code>shaarli/shaarli</code></a>
313repository.</p>
314<h3 id="available-image-tags">Available image tags</h3>
315<ul>
316<li><code>latest</code>: master branch (tarball release)</li>
317<li><code>stable</code>: stable branch (tarball release)</li>
318<li><code>dev</code>: master branch (Git clone)</li>
319</ul>
320<p>All images rely on:
321- <a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a>
322- <a href="http://php-fpm.org/">PHP5-FPM</a>
323- <a href="http://nginx.org/">Nginx</a></p>
324<h3 id="download-from-dockerhub">Download from DockerHub</h3>
325<pre><code class="bash">$ docker pull shaarli/shaarli
326latest: Pulling from shaarli/shaarli
32732716d9fcddb: Pull complete
32884899d045435: Pull complete
3294b6ad7444763: Pull complete
330e0345ef7a3e0: Pull complete
3315c1dd344094f: Pull complete
3326422305a200b: Pull complete
3337d63f861dbef: Pull complete
3343eb97210645c: Pull complete
335869319d746ff: Already exists
336869319d746ff: Pulling fs layer
337902b87aaaec9: Already exists
338Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
339Status: Downloaded newer image for shaarli/shaarli:latest
340</code></pre>
341
342<h3 id="create-and-start-a-new-container-from-the-image">Create and start a new container from the image</h3>
343<pre><code class="bash"># map the host's :8000 port to the container's :80 port
344$ docker create -p 8000:80 shaarli/shaarli
345d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
346
347# launch the container in the background
348$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
349d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
350
351# list active containers
352$ docker ps
353CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
354d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000-&gt;80/tcp backstabbing_galileo
355</code></pre>
356
357<h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3>
358<pre><code class="bash">$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!
359backstabbing_galileo
360
361# check the container is stopped
362$ docker ps
363CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
364
365# list ALL containers
366$ docker ps -a
367CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
368d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo
369
370# destroy the container
371$ docker rm backstabbing_galileo # let's put an end to these barbarian practices
372backstabbing_galileo
373
374$ docker ps -a
375CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
376</code></pre>
377
378 </div>
379 </div>
380 <footer>
381
382 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
383
384 <a href="../Reverse-proxy-configuration/" class="btn btn-neutral float-right" title="Reverse proxy configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
385
386
387 <a href="../Docker-101/" class="btn btn-neutral" title="Docker 101"><span class="icon icon-circle-arrow-left"></span> Previous</a>
388
389 </div>
390
391
392 <hr/>
393
394 <div role="contentinfo">
395 <!-- Copyright etc -->
396
397 </div>
398
399 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>.
400</footer>
401
402 </div>
403 </div>
404
405 </section>
406
407 </div>
408
409 <div class="rst-versions" role="note" style="cursor: pointer">
410 <span class="rst-current-version" data-toggle="rst-current-version">
411
412 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
413
414
415 <span><a href="../Docker-101/" style="color: #fcfcfc;">&laquo; Previous</a></span>
416
417
418 <span style="margin-left: 15px"><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
419
420 </span>
421</div>
422 <script src="../js/theme.js"></script>
423
424</body>
425</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-02 13:03:56 +0000