aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Server-requirements/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/Server-requirements/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/Server-requirements/index.html')
-rw-r--r--doc/html/Server-requirements/index.html475
1 files changed, 475 insertions, 0 deletions
diff --git a/doc/html/Server-requirements/index.html b/doc/html/Server-requirements/index.html
new file mode 100644
index 00000000..ab1b0d35
--- /dev/null
+++ b/doc/html/Server-requirements/index.html
@@ -0,0 +1,475 @@
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>Server requirements - 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 = "Server requirements";
22 var mkdocs_page_input_path = "Server-requirements.md";
23 var mkdocs_page_url = "/Server-requirements/";
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=" current">
69
70 <a class="current" href="./">Server requirements</a>
71 <ul class="subnav">
72
73 <li class="toctree-l3"><a href="#php">PHP</a></li>
74
75 <ul>
76
77 <li><a class="toctree-l4" href="#release-information">Release information</a></li>
78
79 <li><a class="toctree-l4" href="#supported-versions">Supported versions</a></li>
80
81 <li><a class="toctree-l4" href="#dependency-management">Dependency management</a></li>
82
83 <li><a class="toctree-l4" href="#extensions">Extensions</a></li>
84
85 </ul>
86
87
88 </ul>
89 </li>
90 <li class="">
91
92 <a class="" href="../Server-configuration/">Server configuration</a>
93 </li>
94 <li class="">
95
96 <a class="" href="../Server-security/">Server security</a>
97 </li>
98 <li class="">
99
100 <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
101 </li>
102 <li class="">
103
104 <a class="" href="../Plugins/">Plugins</a>
105 </li>
106 </ul>
107 </li>
108
109 <li class="toctree-l1">
110
111 <span class="caption-text">Docker</span>
112 <ul class="subnav">
113 <li class="">
114
115 <a class="" href="../Docker-101/">Docker 101</a>
116 </li>
117 <li class="">
118
119 <a class="" href="../Shaarli-images/">Shaarli images</a>
120 </li>
121 <li class="">
122
123 <a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
124 </li>
125 <li class="">
126
127 <a class="" href="../Docker-resources/">Docker resources</a>
128 </li>
129 </ul>
130 </li>
131
132 <li class="toctree-l1">
133
134 <span class="caption-text">Usage</span>
135 <ul class="subnav">
136 <li class="">
137
138 <a class="" href="../Features/">Features</a>
139 </li>
140 <li class="">
141
142 <a class="" href="../Bookmarklet/">Bookmarklet</a>
143 </li>
144 <li class="">
145
146 <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
147 </li>
148 <li class="">
149
150 <a class="" href="../Firefox-share/">Firefox share</a>
151 </li>
152 <li class="">
153
154 <a class="" href="../RSS-feeds/">RSS feeds</a>
155 </li>
156 <li class="">
157
158 <a class="" href="../REST-API/">REST API</a>
159 </li>
160 </ul>
161 </li>
162
163 <li class="toctree-l1">
164
165 <span class="caption-text">How To</span>
166 <ul class="subnav">
167 <li class="">
168
169 <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
170 </li>
171 <li class="">
172
173 <a class="" href="../Copy-an-existing-installation-over-SSH-and-serve-it-locally/">Copy an existing installation over SSH and serve it locally</a>
174 </li>
175 <li class="">
176
177 <a class="" href="../Create-and-serve-multiple-Shaarlis-(farm)/">Create and serve multiple Shaarlis (farm)</a>
178 </li>
179 <li class="">
180
181 <a class="" href="../Download-CSS-styles-from-an-OPML-list/">Download CSS styles from an OPML list</a>
182 </li>
183 <li class="">
184
185 <a class="" href="../Datastore-hacks/">Datastore hacks</a>
186 </li>
187 </ul>
188 </li>
189
190 <li class="toctree-l1">
191
192 <a class="" href="../Troubleshooting/">Troubleshooting</a>
193 </li>
194
195 <li class="toctree-l1">
196
197 <span class="caption-text">Development</span>
198 <ul class="subnav">
199 <li class="">
200
201 <a class="" href="../Development-guidelines/">Development guidelines</a>
202 </li>
203 <li class="">
204
205 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
206 </li>
207 <li class="">
208
209 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
210 </li>
211 <li class="">
212
213 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
214 </li>
215 <li class="">
216
217 <a class="" href="../Directory-structure/">Directory structure</a>
218 </li>
219 <li class="">
220
221 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
222 </li>
223 <li class="">
224
225 <a class="" href="../Plugin-System/">Plugin System</a>
226 </li>
227 <li class="">
228
229 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
230 </li>
231 <li class="">
232
233 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
234 </li>
235 <li class="">
236
237 <a class="" href="../Security/">Security</a>
238 </li>
239 <li class="">
240
241 <a class="" href="../Static-analysis/">Static analysis</a>
242 </li>
243 <li class="">
244
245 <a class="" href="../Theming/">Theming</a>
246 </li>
247 <li class="">
248
249 <a class="" href="../Unit-tests/">Unit tests</a>
250 </li>
251 </ul>
252 </li>
253
254 <li class="toctree-l1">
255
256 <span class="caption-text">About</span>
257 <ul class="subnav">
258 <li class="">
259
260 <a class="" href="../FAQ/">FAQ</a>
261 </li>
262 <li class="">
263
264 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
265 </li>
266 </ul>
267 </li>
268
269 </ul>
270 </div>
271 &nbsp;
272 </nav>
273
274 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
275
276
277 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
278 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
279 <a href="..">Shaarli Documentation</a>
280 </nav>
281
282
283 <div class="wy-nav-content">
284 <div class="rst-content">
285 <div role="navigation" aria-label="breadcrumbs navigation">
286 <ul class="wy-breadcrumbs">
287 <li><a href="..">Docs</a> &raquo;</li>
288
289
290
291 <li>Setup &raquo;</li>
292
293
294
295 <li>Server requirements</li>
296 <li class="wy-breadcrumbs-aside">
297
298 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Server-requirements.md"
299 class="icon icon-github"> Edit on GitHub</a>
300
301 </li>
302 </ul>
303 <hr/>
304</div>
305 <div role="main">
306 <div class="section">
307
308 <h2 id="php">PHP</h2>
309<h3 id="release-information">Release information</h3>
310<ul>
311<li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a></li>
312<li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em></li>
313<li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a></li>
314<li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a></li>
315<li><a href="https://bugs.php.net/">PHP: Bugs</a></li>
316</ul>
317<h3 id="supported-versions">Supported versions</h3>
318<table>
319<thead>
320<tr>
321<th align="center">Version</th>
322<th align="center">Status</th>
323<th align="center">Shaarli compatibility</th>
324</tr>
325</thead>
326<tbody>
327<tr>
328<td align="center">7.1</td>
329<td align="center">Supported (v0.9.x)</td>
330<td align="center">:white_check_mark:</td>
331</tr>
332<tr>
333<td align="center">7.0</td>
334<td align="center">Supported</td>
335<td align="center">:white_check_mark:</td>
336</tr>
337<tr>
338<td align="center">5.6</td>
339<td align="center">Supported</td>
340<td align="center">:white_check_mark:</td>
341</tr>
342<tr>
343<td align="center">5.5</td>
344<td align="center">EOL: 2016-07-10</td>
345<td align="center">:white_check_mark:</td>
346</tr>
347<tr>
348<td align="center">5.4</td>
349<td align="center">EOL: 2015-09-14</td>
350<td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td>
351</tr>
352<tr>
353<td align="center">5.3</td>
354<td align="center">EOL: 2014-08-14</td>
355<td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td>
356</tr>
357</tbody>
358</table>
359<p>See also:
360- <a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a></p>
361<h3 id="dependency-management">Dependency management</h3>
362<p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve,
363download and install third-party PHP dependencies.</p>
364<table>
365<thead>
366<tr>
367<th>Library</th>
368<th align="center">Required?</th>
369<th>Usage</th>
370</tr>
371</thead>
372<tbody>
373<tr>
374<td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td>
375<td align="center">All</td>
376<td>Import bookmarks from Netscape files</td>
377</tr>
378<tr>
379<td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td>
380<td align="center">All</td>
381<td>Parse MarkDown syntax for the MarkDown plugin</td>
382</tr>
383<tr>
384<td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td>
385<td align="center">All</td>
386<td>Handle routes and middleware for the REST API</td>
387</tr>
388</tbody>
389</table>
390<h3 id="extensions">Extensions</h3>
391<table>
392<thead>
393<tr>
394<th>Extension</th>
395<th align="center">Required?</th>
396<th>Usage</th>
397</tr>
398</thead>
399<tbody>
400<tr>
401<td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td>
402<td align="center">All</td>
403<td>OpenSSL, HTTPS</td>
404</tr>
405<tr>
406<td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td>
407<td align="center">CentOS, Fedora, RHEL, Windows</td>
408<td>multibyte (Unicode) string support</td>
409</tr>
410<tr>
411<td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td>
412<td align="center">optional</td>
413<td>thumbnail resizing</td>
414</tr>
415<tr>
416<td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td>
417<td align="center">optional</td>
418<td>localized text sorting (e.g. <code>e-&gt;รจ-&gt;f</code>)</td>
419</tr>
420<tr>
421<td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td>
422<td align="center">optional</td>
423<td>using cURL for fetching webpages and thumbnails in a more robust way</td>
424</tr>
425</tbody>
426</table>
427
428 </div>
429 </div>
430 <footer>
431
432 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
433
434 <a href="../Server-configuration/" class="btn btn-neutral float-right" title="Server configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
435
436
437 <a href="../Upgrade-and-migration/" class="btn btn-neutral" title="Upgrade and migration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
438
439 </div>
440
441
442 <hr/>
443
444 <div role="contentinfo">
445 <!-- Copyright etc -->
446
447 </div>
448
449 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>.
450</footer>
451
452 </div>
453 </div>
454
455 </section>
456
457 </div>
458
459 <div class="rst-versions" role="note" style="cursor: pointer">
460 <span class="rst-current-version" data-toggle="rst-current-version">
461
462 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
463
464
465 <span><a href="../Upgrade-and-migration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
466
467
468 <span style="margin-left: 15px"><a href="../Server-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
469
470 </span>
471</div>
472 <script src="../js/theme.js"></script>
473
474</body>
475</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-13 08:07:06 +0000