aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Shaarli-images
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-07-04 21:37:30 +0200
committerGitHub <noreply@github.com>2017-07-04 21:37:30 +0200
commit5b25a9635fe808bc1c4f3eee8cdf8485115da75d (patch)
treed5c46525f3c739d9c63de860427e0b3cadd688e5 /doc/html/Shaarli-images
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
parent8bf94136e10c64496711c8f66a4f58f89c515360 (diff)
downloadShaarli-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/Shaarli-images')
-rw-r--r--doc/html/Shaarli-images/index.html413
1 files changed, 413 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..4a1cf66b
--- /dev/null
+++ b/doc/html/Shaarli-images/index.html
@@ -0,0 +1,413 @@
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="../Various-hacks/">Various hacks</a>
176 </li>
177 </ul>
178 </li>
179
180 <li class="toctree-l1">
181
182 <a class="" href="../Troubleshooting/">Troubleshooting</a>
183 </li>
184
185 <li class="toctree-l1">
186
187 <span class="caption-text">Development</span>
188 <ul class="subnav">
189 <li class="">
190
191 <a class="" href="../Development-guidelines/">Development guidelines</a>
192 </li>
193 <li class="">
194
195 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
196 </li>
197 <li class="">
198
199 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
200 </li>
201 <li class="">
202
203 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
204 </li>
205 <li class="">
206
207 <a class="" href="../Directory-structure/">Directory structure</a>
208 </li>
209 <li class="">
210
211 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
212 </li>
213 <li class="">
214
215 <a class="" href="../Plugin-System/">Plugin System</a>
216 </li>
217 <li class="">
218
219 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
220 </li>
221 <li class="">
222
223 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
224 </li>
225 <li class="">
226
227 <a class="" href="../Security/">Security</a>
228 </li>
229 <li class="">
230
231 <a class="" href="../Static-analysis/">Static analysis</a>
232 </li>
233 <li class="">
234
235 <a class="" href="../Theming/">Theming</a>
236 </li>
237 <li class="">
238
239 <a class="" href="../Unit-tests/">Unit tests</a>
240 </li>
241 </ul>
242 </li>
243
244 <li class="toctree-l1">
245
246 <span class="caption-text">About</span>
247 <ul class="subnav">
248 <li class="">
249
250 <a class="" href="../FAQ/">FAQ</a>
251 </li>
252 <li class="">
253
254 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
255 </li>
256 </ul>
257 </li>
258
259 </ul>
260 </div>
261 &nbsp;
262 </nav>
263
264 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
265
266
267 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
268 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
269 <a href="..">Shaarli Documentation</a>
270 </nav>
271
272
273 <div class="wy-nav-content">
274 <div class="rst-content">
275 <div role="navigation" aria-label="breadcrumbs navigation">
276 <ul class="wy-breadcrumbs">
277 <li><a href="..">Docs</a> &raquo;</li>
278
279
280
281 <li>Docker &raquo;</li>
282
283
284
285 <li>Shaarli images</li>
286 <li class="wy-breadcrumbs-aside">
287
288 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Shaarli-images.md"
289 class="icon icon-github"> Edit on GitHub</a>
290
291 </li>
292 </ul>
293 <hr/>
294</div>
295 <div role="main">
296 <div class="section">
297
298 <h2 id="get-and-run-a-shaarli-image">Get and run a Shaarli image</h2>
299<h3 id="dockerhub-repository">DockerHub repository</h3>
300<p>The images can be found in the <a href="https://hub.docker.com/r/shaarli/shaarli/"><code>shaarli/shaarli</code></a>
301repository.</p>
302<h3 id="available-image-tags">Available image tags</h3>
303<ul>
304<li><code>latest</code>: master branch (tarball release)</li>
305<li><code>stable</code>: stable branch (tarball release)</li>
306<li><code>dev</code>: master branch (Git clone)</li>
307</ul>
308<p>All images rely on:
309- <a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a>
310- <a href="http://php-fpm.org/">PHP5-FPM</a>
311- <a href="http://nginx.org/">Nginx</a></p>
312<h3 id="download-from-dockerhub">Download from DockerHub</h3>
313<pre><code class="bash">$ docker pull shaarli/shaarli
314latest: Pulling from shaarli/shaarli
31532716d9fcddb: Pull complete
31684899d045435: Pull complete
3174b6ad7444763: Pull complete
318e0345ef7a3e0: Pull complete
3195c1dd344094f: Pull complete
3206422305a200b: Pull complete
3217d63f861dbef: Pull complete
3223eb97210645c: Pull complete
323869319d746ff: Already exists
324869319d746ff: Pulling fs layer
325902b87aaaec9: Already exists
326Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
327Status: Downloaded newer image for shaarli/shaarli:latest
328</code></pre>
329
330<h3 id="create-and-start-a-new-container-from-the-image">Create and start a new container from the image</h3>
331<pre><code class="bash"># map the host's :8000 port to the container's :80 port
332$ docker create -p 8000:80 shaarli/shaarli
333d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
334
335# launch the container in the background
336$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
337d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
338
339# list active containers
340$ docker ps
341CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
342d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000-&gt;80/tcp backstabbing_galileo
343</code></pre>
344
345<h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3>
346<pre><code class="bash">$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!
347backstabbing_galileo
348
349# check the container is stopped
350$ docker ps
351CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
352
353# list ALL containers
354$ docker ps -a
355CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
356d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo
357
358# destroy the container
359$ docker rm backstabbing_galileo # let's put an end to these barbarian practices
360backstabbing_galileo
361
362$ docker ps -a
363CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
364</code></pre>
365
366 </div>
367 </div>
368 <footer>
369
370 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
371
372 <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>
373
374
375 <a href="../Docker-101/" class="btn btn-neutral" title="Docker 101"><span class="icon icon-circle-arrow-left"></span> Previous</a>
376
377 </div>
378
379
380 <hr/>
381
382 <div role="contentinfo">
383 <!-- Copyright etc -->
384
385 </div>
386
387 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>.
388</footer>
389
390 </div>
391 </div>
392
393 </section>
394
395 </div>
396
397 <div class="rst-versions" role="note" style="cursor: pointer">
398 <span class="rst-current-version" data-toggle="rst-current-version">
399
400 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
401
402
403 <span><a href="../Docker-101/" style="color: #fcfcfc;">&laquo; Previous</a></span>
404
405
406 <span style="margin-left: 15px"><a href="../Reverse-proxy-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
407
408 </span>
409</div>
410 <script src="../js/theme.js"></script>
411
412</body>
413</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-17 08:45:46 +0000