aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/html/Server-requirements/index.html
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/Server-requirements/index.html
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/Server-requirements/index.html')
-rw-r--r--doc/html/Server-requirements/index.html463
1 files changed, 463 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..f3bfa185
--- /dev/null
+++ b/doc/html/Server-requirements/index.html
@@ -0,0 +1,463 @@
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="../Various-hacks/">Various hacks</a>
174 </li>
175 </ul>
176 </li>
177
178 <li class="toctree-l1">
179
180 <a class="" href="../Troubleshooting/">Troubleshooting</a>
181 </li>
182
183 <li class="toctree-l1">
184
185 <span class="caption-text">Development</span>
186 <ul class="subnav">
187 <li class="">
188
189 <a class="" href="../Development-guidelines/">Development guidelines</a>
190 </li>
191 <li class="">
192
193 <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
194 </li>
195 <li class="">
196
197 <a class="" href="../GnuPG-signature/">GnuPG signature</a>
198 </li>
199 <li class="">
200
201 <a class="" href="../Coding-guidelines/">Coding guidelines</a>
202 </li>
203 <li class="">
204
205 <a class="" href="../Directory-structure/">Directory structure</a>
206 </li>
207 <li class="">
208
209 <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
210 </li>
211 <li class="">
212
213 <a class="" href="../Plugin-System/">Plugin System</a>
214 </li>
215 <li class="">
216
217 <a class="" href="../Release-Shaarli/">Release Shaarli</a>
218 </li>
219 <li class="">
220
221 <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
222 </li>
223 <li class="">
224
225 <a class="" href="../Security/">Security</a>
226 </li>
227 <li class="">
228
229 <a class="" href="../Static-analysis/">Static analysis</a>
230 </li>
231 <li class="">
232
233 <a class="" href="../Theming/">Theming</a>
234 </li>
235 <li class="">
236
237 <a class="" href="../Unit-tests/">Unit tests</a>
238 </li>
239 </ul>
240 </li>
241
242 <li class="toctree-l1">
243
244 <span class="caption-text">About</span>
245 <ul class="subnav">
246 <li class="">
247
248 <a class="" href="../FAQ/">FAQ</a>
249 </li>
250 <li class="">
251
252 <a class="" href="../Community-&-Related-software/">Community & Related software</a>
253 </li>
254 </ul>
255 </li>
256
257 </ul>
258 </div>
259 &nbsp;
260 </nav>
261
262 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
263
264
265 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
266 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
267 <a href="..">Shaarli Documentation</a>
268 </nav>
269
270
271 <div class="wy-nav-content">
272 <div class="rst-content">
273 <div role="navigation" aria-label="breadcrumbs navigation">
274 <ul class="wy-breadcrumbs">
275 <li><a href="..">Docs</a> &raquo;</li>
276
277
278
279 <li>Setup &raquo;</li>
280
281
282
283 <li>Server requirements</li>
284 <li class="wy-breadcrumbs-aside">
285
286 <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Server-requirements.md"
287 class="icon icon-github"> Edit on GitHub</a>
288
289 </li>
290 </ul>
291 <hr/>
292</div>
293 <div role="main">
294 <div class="section">
295
296 <h2 id="php">PHP</h2>
297<h3 id="release-information">Release information</h3>
298<ul>
299<li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a></li>
300<li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em></li>
301<li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a></li>
302<li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a></li>
303<li><a href="https://bugs.php.net/">PHP: Bugs</a></li>
304</ul>
305<h3 id="supported-versions">Supported versions</h3>
306<table>
307<thead>
308<tr>
309<th align="center">Version</th>
310<th align="center">Status</th>
311<th align="center">Shaarli compatibility</th>
312</tr>
313</thead>
314<tbody>
315<tr>
316<td align="center">7.1</td>
317<td align="center">Supported (v0.9.x)</td>
318<td align="center">:white_check_mark:</td>
319</tr>
320<tr>
321<td align="center">7.0</td>
322<td align="center">Supported</td>
323<td align="center">:white_check_mark:</td>
324</tr>
325<tr>
326<td align="center">5.6</td>
327<td align="center">Supported</td>
328<td align="center">:white_check_mark:</td>
329</tr>
330<tr>
331<td align="center">5.5</td>
332<td align="center">EOL: 2016-07-10</td>
333<td align="center">:white_check_mark:</td>
334</tr>
335<tr>
336<td align="center">5.4</td>
337<td align="center">EOL: 2015-09-14</td>
338<td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td>
339</tr>
340<tr>
341<td align="center">5.3</td>
342<td align="center">EOL: 2014-08-14</td>
343<td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td>
344</tr>
345</tbody>
346</table>
347<p>See also:
348- <a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a></p>
349<h3 id="dependency-management">Dependency management</h3>
350<p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve,
351download and install third-party PHP dependencies.</p>
352<table>
353<thead>
354<tr>
355<th>Library</th>
356<th align="center">Required?</th>
357<th>Usage</th>
358</tr>
359</thead>
360<tbody>
361<tr>
362<td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td>
363<td align="center">All</td>
364<td>Import bookmarks from Netscape files</td>
365</tr>
366<tr>
367<td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td>
368<td align="center">All</td>
369<td>Parse MarkDown syntax for the MarkDown plugin</td>
370</tr>
371<tr>
372<td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td>
373<td align="center">All</td>
374<td>Handle routes and middleware for the REST API</td>
375</tr>
376</tbody>
377</table>
378<h3 id="extensions">Extensions</h3>
379<table>
380<thead>
381<tr>
382<th>Extension</th>
383<th align="center">Required?</th>
384<th>Usage</th>
385</tr>
386</thead>
387<tbody>
388<tr>
389<td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td>
390<td align="center">All</td>
391<td>OpenSSL, HTTPS</td>
392</tr>
393<tr>
394<td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td>
395<td align="center">CentOS, Fedora, RHEL, Windows</td>
396<td>multibyte (Unicode) string support</td>
397</tr>
398<tr>
399<td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td>
400<td align="center">optional</td>
401<td>thumbnail resizing</td>
402</tr>
403<tr>
404<td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td>
405<td align="center">optional</td>
406<td>localized text sorting (e.g. <code>e-&gt;รจ-&gt;f</code>)</td>
407</tr>
408<tr>
409<td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td>
410<td align="center">optional</td>
411<td>using cURL for fetching webpages and thumbnails in a more robust way</td>
412</tr>
413</tbody>
414</table>
415
416 </div>
417 </div>
418 <footer>
419
420 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
421
422 <a href="../Server-configuration/" class="btn btn-neutral float-right" title="Server configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
423
424
425 <a href="../Upgrade-and-migration/" class="btn btn-neutral" title="Upgrade and migration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
426
427 </div>
428
429
430 <hr/>
431
432 <div role="contentinfo">
433 <!-- Copyright etc -->
434
435 </div>
436
437 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>.
438</footer>
439
440 </div>
441 </div>
442
443 </section>
444
445 </div>
446
447 <div class="rst-versions" role="note" style="cursor: pointer">
448 <span class="rst-current-version" data-toggle="rst-current-version">
449
450 <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
451
452
453 <span><a href="../Upgrade-and-migration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
454
455
456 <span style="margin-left: 15px"><a href="../Server-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
457
458 </span>
459</div>
460 <script src="../js/theme.js"></script>
461
462</body>
463</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-18 04:28:53 +0000