diff options
author | VirtualTam <virtualtam@flibidi.net> | 2017-07-29 15:29:54 +0200 |
---|---|---|
committer | VirtualTam <virtualtam@flibidi.net> | 2017-07-29 15:33:35 +0200 |
commit | 3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a (patch) | |
tree | a5f9a26ce2033182fd0d13c9035b44ff9ebbf9fe /doc/html/docker | |
parent | 84d0632a2df1cf833610bc8dd45d4808e4a8dc0e (diff) | |
download | Shaarli-3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a.tar.gz Shaarli-3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a.tar.zst Shaarli-3a6f91a9ccbdd8f2ed8e33c88c7800f2623cfd3a.zip |
Generate HTML documentation
Signed-off-by: VirtualTam <virtualtam@flibidi.net>
Diffstat (limited to 'doc/html/docker')
-rw-r--r-- | doc/html/docker/docker-101/index.html | 398 | ||||
-rw-r--r-- | doc/html/docker/resources/index.html | 358 | ||||
-rw-r--r-- | doc/html/docker/reverse-proxy-configuration/index.html | 338 | ||||
-rw-r--r-- | doc/html/docker/shaarli-images/index.html | 412 |
4 files changed, 1506 insertions, 0 deletions
diff --git a/doc/html/docker/docker-101/index.html b/doc/html/docker/docker-101/index.html new file mode 100644 index 00000000..67a3f8e4 --- /dev/null +++ b/doc/html/docker/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/docker-101.md"; | ||
23 | var mkdocs_page_url = "/docker/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="../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/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> | ||
diff --git a/doc/html/docker/resources/index.html b/doc/html/docker/resources/index.html new file mode 100644 index 00000000..409c4e51 --- /dev/null +++ b/doc/html/docker/resources/index.html | |||
@@ -0,0 +1,358 @@ | |||
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 resources - 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 resources"; | ||
22 | var mkdocs_page_input_path = "docker/resources.md"; | ||
23 | var mkdocs_page_url = "/docker/resources/"; | ||
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=""> | ||
100 | |||
101 | <a class="" href="../shaarli-images/">Shaarli images</a> | ||
102 | </li> | ||
103 | <li class=""> | ||
104 | |||
105 | <a class="" href="../reverse-proxy-configuration/">Reverse proxy configuration</a> | ||
106 | </li> | ||
107 | <li class=" current"> | ||
108 | |||
109 | <a class="current" href="./">Docker resources</a> | ||
110 | <ul class="subnav"> | ||
111 | |||
112 | <li class="toctree-l3"><a href="#docker">Docker</a></li> | ||
113 | |||
114 | |||
115 | <li class="toctree-l3"><a href="#dockerhub">DockerHub</a></li> | ||
116 | |||
117 | |||
118 | <li class="toctree-l3"><a href="#service-management">Service management</a></li> | ||
119 | |||
120 | |||
121 | </ul> | ||
122 | </li> | ||
123 | </ul> | ||
124 | </li> | ||
125 | |||
126 | <li class="toctree-l1"> | ||
127 | |||
128 | <span class="caption-text">Usage</span> | ||
129 | <ul class="subnav"> | ||
130 | <li class=""> | ||
131 | |||
132 | <a class="" href="../../Features/">Features</a> | ||
133 | </li> | ||
134 | <li class=""> | ||
135 | |||
136 | <a class="" href="../../Bookmarklet/">Bookmarklet</a> | ||
137 | </li> | ||
138 | <li class=""> | ||
139 | |||
140 | <a class="" href="../../Browsing-and-searching/">Browsing and searching</a> | ||
141 | </li> | ||
142 | <li class=""> | ||
143 | |||
144 | <a class="" href="../../Firefox-share/">Firefox share</a> | ||
145 | </li> | ||
146 | <li class=""> | ||
147 | |||
148 | <a class="" href="../../RSS-feeds/">RSS feeds</a> | ||
149 | </li> | ||
150 | <li class=""> | ||
151 | |||
152 | <a class="" href="../../REST-API/">REST API</a> | ||
153 | </li> | ||
154 | </ul> | ||
155 | </li> | ||
156 | |||
157 | <li class="toctree-l1"> | ||
158 | |||
159 | <span class="caption-text">How To</span> | ||
160 | <ul class="subnav"> | ||
161 | <li class=""> | ||
162 | |||
163 | <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
164 | </li> | ||
165 | <li class=""> | ||
166 | |||
167 | <a class="" href="../../Various-hacks/">Various hacks</a> | ||
168 | </li> | ||
169 | </ul> | ||
170 | </li> | ||
171 | |||
172 | <li class="toctree-l1"> | ||
173 | |||
174 | <a class="" href="../../Troubleshooting/">Troubleshooting</a> | ||
175 | </li> | ||
176 | |||
177 | <li class="toctree-l1"> | ||
178 | |||
179 | <span class="caption-text">Development</span> | ||
180 | <ul class="subnav"> | ||
181 | <li class=""> | ||
182 | |||
183 | <a class="" href="../../Development-guidelines/">Development guidelines</a> | ||
184 | </li> | ||
185 | <li class=""> | ||
186 | |||
187 | <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a> | ||
188 | </li> | ||
189 | <li class=""> | ||
190 | |||
191 | <a class="" href="../../GnuPG-signature/">GnuPG signature</a> | ||
192 | </li> | ||
193 | <li class=""> | ||
194 | |||
195 | <a class="" href="../../Coding-guidelines/">Coding guidelines</a> | ||
196 | </li> | ||
197 | <li class=""> | ||
198 | |||
199 | <a class="" href="../../Directory-structure/">Directory structure</a> | ||
200 | </li> | ||
201 | <li class=""> | ||
202 | |||
203 | <a class="" href="../../3rd-party-libraries/">3rd party libraries</a> | ||
204 | </li> | ||
205 | <li class=""> | ||
206 | |||
207 | <a class="" href="../../Plugin-System/">Plugin System</a> | ||
208 | </li> | ||
209 | <li class=""> | ||
210 | |||
211 | <a class="" href="../../Release-Shaarli/">Release Shaarli</a> | ||
212 | </li> | ||
213 | <li class=""> | ||
214 | |||
215 | <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a> | ||
216 | </li> | ||
217 | <li class=""> | ||
218 | |||
219 | <a class="" href="../../Security/">Security</a> | ||
220 | </li> | ||
221 | <li class=""> | ||
222 | |||
223 | <a class="" href="../../Static-analysis/">Static analysis</a> | ||
224 | </li> | ||
225 | <li class=""> | ||
226 | |||
227 | <a class="" href="../../Theming/">Theming</a> | ||
228 | </li> | ||
229 | <li class=""> | ||
230 | |||
231 | <a class="" href="../../Unit-tests/">Unit tests</a> | ||
232 | </li> | ||
233 | </ul> | ||
234 | </li> | ||
235 | |||
236 | <li class="toctree-l1"> | ||
237 | |||
238 | <span class="caption-text">About</span> | ||
239 | <ul class="subnav"> | ||
240 | <li class=""> | ||
241 | |||
242 | <a class="" href="../../FAQ/">FAQ</a> | ||
243 | </li> | ||
244 | <li class=""> | ||
245 | |||
246 | <a class="" href="../../Community-&-Related-software/">Community & Related software</a> | ||
247 | </li> | ||
248 | </ul> | ||
249 | </li> | ||
250 | |||
251 | </ul> | ||
252 | </div> | ||
253 | | ||
254 | </nav> | ||
255 | |||
256 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
257 | |||
258 | |||
259 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
260 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
261 | <a href="../..">Shaarli Documentation</a> | ||
262 | </nav> | ||
263 | |||
264 | |||
265 | <div class="wy-nav-content"> | ||
266 | <div class="rst-content"> | ||
267 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
268 | <ul class="wy-breadcrumbs"> | ||
269 | <li><a href="../..">Docs</a> »</li> | ||
270 | |||
271 | |||
272 | |||
273 | <li>Docker »</li> | ||
274 | |||
275 | |||
276 | |||
277 | <li>Docker resources</li> | ||
278 | <li class="wy-breadcrumbs-aside"> | ||
279 | |||
280 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/resources.md" | ||
281 | class="icon icon-github"> Edit on GitHub</a> | ||
282 | |||
283 | </li> | ||
284 | </ul> | ||
285 | <hr/> | ||
286 | </div> | ||
287 | <div role="main"> | ||
288 | <div class="section"> | ||
289 | |||
290 | <h3 id="docker">Docker</h3> | ||
291 | <ul> | ||
292 | <li><a href="https://www.katacoda.com/courses/docker/">Interactive Docker training portal</a> on <a href="https://www.katacoda.com/">Katakoda</a></li> | ||
293 | <li><a href="http://blog.thoward37.me/articles/where-are-docker-images-stored/">Where are Docker images stored?</a></li> | ||
294 | <li><a href="https://docs.docker.com/reference/builder/">Dockerfile reference</a></li> | ||
295 | <li><a href="https://docs.docker.com/articles/dockerfile_best-practices/">Dockerfile best practices</a></li> | ||
296 | <li><a href="https://docs.docker.com/userguide/dockervolumes/">Volumes</a></li> | ||
297 | </ul> | ||
298 | <h3 id="dockerhub">DockerHub</h3> | ||
299 | <ul> | ||
300 | <li><a href="https://docs.docker.com/userguide/dockerrepos/">Repositories</a></li> | ||
301 | <li><a href="https://docs.docker.com/docker-hub/orgs/">Teams and organizations</a></li> | ||
302 | <li><a href="https://docs.docker.com/docker-hub/github/">GitHub automated build</a></li> | ||
303 | </ul> | ||
304 | <h3 id="service-management">Service management</h3> | ||
305 | <ul> | ||
306 | <li><a href="https://docs.docker.com/articles/using_supervisord/">Using supervisord</a></li> | ||
307 | <li><a href="http://nginx.org/en/docs/ngx_core_module.html#daemon">Nginx in the foreground</a></li> | ||
308 | <li><a href="http://supervisord.org/">supervisord</a></li> | ||
309 | </ul> | ||
310 | |||
311 | </div> | ||
312 | </div> | ||
313 | <footer> | ||
314 | |||
315 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
316 | |||
317 | <a href="../../Features/" class="btn btn-neutral float-right" title="Features">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
318 | |||
319 | |||
320 | <a href="../reverse-proxy-configuration/" class="btn btn-neutral" title="Reverse proxy configuration"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
321 | |||
322 | </div> | ||
323 | |||
324 | |||
325 | <hr/> | ||
326 | |||
327 | <div role="contentinfo"> | ||
328 | <!-- Copyright etc --> | ||
329 | |||
330 | </div> | ||
331 | |||
332 | 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>. | ||
333 | </footer> | ||
334 | |||
335 | </div> | ||
336 | </div> | ||
337 | |||
338 | </section> | ||
339 | |||
340 | </div> | ||
341 | |||
342 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
343 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
344 | |||
345 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
346 | |||
347 | |||
348 | <span><a href="../reverse-proxy-configuration/" style="color: #fcfcfc;">« Previous</a></span> | ||
349 | |||
350 | |||
351 | <span style="margin-left: 15px"><a href="../../Features/" style="color: #fcfcfc">Next »</a></span> | ||
352 | |||
353 | </span> | ||
354 | </div> | ||
355 | <script src="../../js/theme.js"></script> | ||
356 | |||
357 | </body> | ||
358 | </html> | ||
diff --git a/doc/html/docker/reverse-proxy-configuration/index.html b/doc/html/docker/reverse-proxy-configuration/index.html new file mode 100644 index 00000000..fd1187c9 --- /dev/null +++ b/doc/html/docker/reverse-proxy-configuration/index.html | |||
@@ -0,0 +1,338 @@ | |||
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>Reverse proxy configuration - 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 = "Reverse proxy configuration"; | ||
22 | var mkdocs_page_input_path = "docker/reverse-proxy-configuration.md"; | ||
23 | var mkdocs_page_url = "/docker/reverse-proxy-configuration/"; | ||
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=""> | ||
100 | |||
101 | <a class="" href="../shaarli-images/">Shaarli images</a> | ||
102 | </li> | ||
103 | <li class=" current"> | ||
104 | |||
105 | <a class="current" href="./">Reverse proxy configuration</a> | ||
106 | <ul class="subnav"> | ||
107 | |||
108 | <li class="toctree-l3"><a href="#haproxy">HAProxy</a></li> | ||
109 | |||
110 | |||
111 | <li class="toctree-l3"><a href="#nginx">Nginx</a></li> | ||
112 | |||
113 | |||
114 | </ul> | ||
115 | </li> | ||
116 | <li class=""> | ||
117 | |||
118 | <a class="" href="../resources/">Docker resources</a> | ||
119 | </li> | ||
120 | </ul> | ||
121 | </li> | ||
122 | |||
123 | <li class="toctree-l1"> | ||
124 | |||
125 | <span class="caption-text">Usage</span> | ||
126 | <ul class="subnav"> | ||
127 | <li class=""> | ||
128 | |||
129 | <a class="" href="../../Features/">Features</a> | ||
130 | </li> | ||
131 | <li class=""> | ||
132 | |||
133 | <a class="" href="../../Bookmarklet/">Bookmarklet</a> | ||
134 | </li> | ||
135 | <li class=""> | ||
136 | |||
137 | <a class="" href="../../Browsing-and-searching/">Browsing and searching</a> | ||
138 | </li> | ||
139 | <li class=""> | ||
140 | |||
141 | <a class="" href="../../Firefox-share/">Firefox share</a> | ||
142 | </li> | ||
143 | <li class=""> | ||
144 | |||
145 | <a class="" href="../../RSS-feeds/">RSS feeds</a> | ||
146 | </li> | ||
147 | <li class=""> | ||
148 | |||
149 | <a class="" href="../../REST-API/">REST API</a> | ||
150 | </li> | ||
151 | </ul> | ||
152 | </li> | ||
153 | |||
154 | <li class="toctree-l1"> | ||
155 | |||
156 | <span class="caption-text">How To</span> | ||
157 | <ul class="subnav"> | ||
158 | <li class=""> | ||
159 | |||
160 | <a class="" href="../../Backup,-restore,-import-and-export/">Backup, restore, import and export</a> | ||
161 | </li> | ||
162 | <li class=""> | ||
163 | |||
164 | <a class="" href="../../Various-hacks/">Various hacks</a> | ||
165 | </li> | ||
166 | </ul> | ||
167 | </li> | ||
168 | |||
169 | <li class="toctree-l1"> | ||
170 | |||
171 | <a class="" href="../../Troubleshooting/">Troubleshooting</a> | ||
172 | </li> | ||
173 | |||
174 | <li class="toctree-l1"> | ||
175 | |||
176 | <span class="caption-text">Development</span> | ||
177 | <ul class="subnav"> | ||
178 | <li class=""> | ||
179 | |||
180 | <a class="" href="../../Development-guidelines/">Development guidelines</a> | ||
181 | </li> | ||
182 | <li class=""> | ||
183 | |||
184 | <a class="" href="../../Continuous-integration-tools/">Continuous integration tools</a> | ||
185 | </li> | ||
186 | <li class=""> | ||
187 | |||
188 | <a class="" href="../../GnuPG-signature/">GnuPG signature</a> | ||
189 | </li> | ||
190 | <li class=""> | ||
191 | |||
192 | <a class="" href="../../Coding-guidelines/">Coding guidelines</a> | ||
193 | </li> | ||
194 | <li class=""> | ||
195 | |||
196 | <a class="" href="../../Directory-structure/">Directory structure</a> | ||
197 | </li> | ||
198 | <li class=""> | ||
199 | |||
200 | <a class="" href="../../3rd-party-libraries/">3rd party libraries</a> | ||
201 | </li> | ||
202 | <li class=""> | ||
203 | |||
204 | <a class="" href="../../Plugin-System/">Plugin System</a> | ||
205 | </li> | ||
206 | <li class=""> | ||
207 | |||
208 | <a class="" href="../../Release-Shaarli/">Release Shaarli</a> | ||
209 | </li> | ||
210 | <li class=""> | ||
211 | |||
212 | <a class="" href="../../Versioning-and-Branches/">Versioning and Branches</a> | ||
213 | </li> | ||
214 | <li class=""> | ||
215 | |||
216 | <a class="" href="../../Security/">Security</a> | ||
217 | </li> | ||
218 | <li class=""> | ||
219 | |||
220 | <a class="" href="../../Static-analysis/">Static analysis</a> | ||
221 | </li> | ||
222 | <li class=""> | ||
223 | |||
224 | <a class="" href="../../Theming/">Theming</a> | ||
225 | </li> | ||
226 | <li class=""> | ||
227 | |||
228 | <a class="" href="../../Unit-tests/">Unit tests</a> | ||
229 | </li> | ||
230 | </ul> | ||
231 | </li> | ||
232 | |||
233 | <li class="toctree-l1"> | ||
234 | |||
235 | <span class="caption-text">About</span> | ||
236 | <ul class="subnav"> | ||
237 | <li class=""> | ||
238 | |||
239 | <a class="" href="../../FAQ/">FAQ</a> | ||
240 | </li> | ||
241 | <li class=""> | ||
242 | |||
243 | <a class="" href="../../Community-&-Related-software/">Community & Related software</a> | ||
244 | </li> | ||
245 | </ul> | ||
246 | </li> | ||
247 | |||
248 | </ul> | ||
249 | </div> | ||
250 | | ||
251 | </nav> | ||
252 | |||
253 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
254 | |||
255 | |||
256 | <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
257 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
258 | <a href="../..">Shaarli Documentation</a> | ||
259 | </nav> | ||
260 | |||
261 | |||
262 | <div class="wy-nav-content"> | ||
263 | <div class="rst-content"> | ||
264 | <div role="navigation" aria-label="breadcrumbs navigation"> | ||
265 | <ul class="wy-breadcrumbs"> | ||
266 | <li><a href="../..">Docs</a> »</li> | ||
267 | |||
268 | |||
269 | |||
270 | <li>Docker »</li> | ||
271 | |||
272 | |||
273 | |||
274 | <li>Reverse proxy configuration</li> | ||
275 | <li class="wy-breadcrumbs-aside"> | ||
276 | |||
277 | <a href="https://github.com/shaarli/Shaarli/edit/master/docs/docker/reverse-proxy-configuration.md" | ||
278 | class="icon icon-github"> Edit on GitHub</a> | ||
279 | |||
280 | </li> | ||
281 | </ul> | ||
282 | <hr/> | ||
283 | </div> | ||
284 | <div role="main"> | ||
285 | <div class="section"> | ||
286 | |||
287 | <p>TODO, see https://github.com/shaarli/Shaarli/issues/888</p> | ||
288 | <h2 id="haproxy">HAProxy</h2> | ||
289 | <h2 id="nginx">Nginx</h2> | ||
290 | |||
291 | </div> | ||
292 | </div> | ||
293 | <footer> | ||
294 | |||
295 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
296 | |||
297 | <a href="../resources/" class="btn btn-neutral float-right" title="Docker resources">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
298 | |||
299 | |||
300 | <a href="../shaarli-images/" class="btn btn-neutral" title="Shaarli images"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
301 | |||
302 | </div> | ||
303 | |||
304 | |||
305 | <hr/> | ||
306 | |||
307 | <div role="contentinfo"> | ||
308 | <!-- Copyright etc --> | ||
309 | |||
310 | </div> | ||
311 | |||
312 | 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>. | ||
313 | </footer> | ||
314 | |||
315 | </div> | ||
316 | </div> | ||
317 | |||
318 | </section> | ||
319 | |||
320 | </div> | ||
321 | |||
322 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
323 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
324 | |||
325 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
326 | |||
327 | |||
328 | <span><a href="../shaarli-images/" style="color: #fcfcfc;">« Previous</a></span> | ||
329 | |||
330 | |||
331 | <span style="margin-left: 15px"><a href="../resources/" style="color: #fcfcfc">Next »</a></span> | ||
332 | |||
333 | </span> | ||
334 | </div> | ||
335 | <script src="../../js/theme.js"></script> | ||
336 | |||
337 | </body> | ||
338 | </html> | ||
diff --git a/doc/html/docker/shaarli-images/index.html b/doc/html/docker/shaarli-images/index.html new file mode 100644 index 00000000..6938b65f --- /dev/null +++ b/doc/html/docker/shaarli-images/index.html | |||
@@ -0,0 +1,412 @@ | |||
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 = "docker/shaarli-images.md"; | ||
23 | var mkdocs_page_url = "/docker/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="../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 | | ||
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> »</li> | ||
278 | |||
279 | |||
280 | |||
281 | <li>Docker »</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/docker/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> | ||
301 | repository.</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 | </ul> | ||
307 | <p>All images rely on: | ||
308 | - <a href="https://hub.docker.com/_/debian/">Debian 8 Jessie</a> | ||
309 | - <a href="http://php-fpm.org/">PHP5-FPM</a> | ||
310 | - <a href="http://nginx.org/">Nginx</a></p> | ||
311 | <h3 id="download-from-dockerhub">Download from DockerHub</h3> | ||
312 | <pre><code class="bash">$ docker pull shaarli/shaarli | ||
313 | latest: Pulling from shaarli/shaarli | ||
314 | 32716d9fcddb: Pull complete | ||
315 | 84899d045435: Pull complete | ||
316 | 4b6ad7444763: Pull complete | ||
317 | e0345ef7a3e0: Pull complete | ||
318 | 5c1dd344094f: Pull complete | ||
319 | 6422305a200b: Pull complete | ||
320 | 7d63f861dbef: Pull complete | ||
321 | 3eb97210645c: Pull complete | ||
322 | 869319d746ff: Already exists | ||
323 | 869319d746ff: Pulling fs layer | ||
324 | 902b87aaaec9: Already exists | ||
325 | Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98 | ||
326 | Status: Downloaded newer image for shaarli/shaarli:latest | ||
327 | </code></pre> | ||
328 | |||
329 | <h3 id="create-and-start-a-new-container-from-the-image">Create and start a new container from the image</h3> | ||
330 | <pre><code class="bash"># map the host's :8000 port to the container's :80 port | ||
331 | $ docker create -p 8000:80 shaarli/shaarli | ||
332 | d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
333 | |||
334 | # launch the container in the background | ||
335 | $ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
336 | d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101 | ||
337 | |||
338 | # list active containers | ||
339 | $ docker ps | ||
340 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
341 | d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo | ||
342 | </code></pre> | ||
343 | |||
344 | <h3 id="stop-and-destroy-a-container">Stop and destroy a container</h3> | ||
345 | <pre><code class="bash">$ docker stop backstabbing_galileo # those docker guys are really rude to physicists! | ||
346 | backstabbing_galileo | ||
347 | |||
348 | # check the container is stopped | ||
349 | $ docker ps | ||
350 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
351 | |||
352 | # list ALL containers | ||
353 | $ docker ps -a | ||
354 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
355 | d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo | ||
356 | |||
357 | # destroy the container | ||
358 | $ docker rm backstabbing_galileo # let's put an end to these barbarian practices | ||
359 | backstabbing_galileo | ||
360 | |||
361 | $ docker ps -a | ||
362 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
363 | </code></pre> | ||
364 | |||
365 | </div> | ||
366 | </div> | ||
367 | <footer> | ||
368 | |||
369 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
370 | |||
371 | <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> | ||
372 | |||
373 | |||
374 | <a href="../docker-101/" class="btn btn-neutral" title="Docker 101"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
375 | |||
376 | </div> | ||
377 | |||
378 | |||
379 | <hr/> | ||
380 | |||
381 | <div role="contentinfo"> | ||
382 | <!-- Copyright etc --> | ||
383 | |||
384 | </div> | ||
385 | |||
386 | 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>. | ||
387 | </footer> | ||
388 | |||
389 | </div> | ||
390 | </div> | ||
391 | |||
392 | </section> | ||
393 | |||
394 | </div> | ||
395 | |||
396 | <div class="rst-versions" role="note" style="cursor: pointer"> | ||
397 | <span class="rst-current-version" data-toggle="rst-current-version"> | ||
398 | |||
399 | <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a> | ||
400 | |||
401 | |||
402 | <span><a href="../docker-101/" style="color: #fcfcfc;">« Previous</a></span> | ||
403 | |||
404 | |||
405 | <span style="margin-left: 15px"><a href="../reverse-proxy-configuration/" style="color: #fcfcfc">Next »</a></span> | ||
406 | |||
407 | </span> | ||
408 | </div> | ||
409 | <script src="../../js/theme.js"></script> | ||
410 | |||
411 | </body> | ||
412 | </html> | ||