index.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
  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. <link rel="shortcut icon" href="../img/favicon.ico">
  9. <title>Server requirements - Shaarli Documentation</title>
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
  11. <link rel="stylesheet" href="../css/theme.css" type="text/css" />
  12. <link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
  13. <link rel="stylesheet" href="../css/highlight.css">
  14. <link href="../github-markdown.css" rel="stylesheet">
  15. <script>
  16. // Current page data
  17. var mkdocs_page_name = "Server requirements";
  18. var mkdocs_page_input_path = "Server-requirements.md";
  19. var mkdocs_page_url = "/Server-requirements/";
  20. </script>
  21. <script src="../js/jquery-2.1.1.min.js"></script>
  22. <script src="../js/modernizr-2.8.3.min.js"></script>
  23. <script type="text/javascript" src="../js/highlight.pack.js"></script>
  24. </head>
  25. <body class="wy-body-for-nav" role="document">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
  28. <div class="wy-side-nav-search">
  29. <a href=".." class="icon icon-home"> Shaarli Documentation</a>
  30. <div role="search">
  31. <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
  32. <input type="text" name="q" placeholder="Search docs" />
  33. </form>
  34. </div>
  35. </div>
  36. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  37. <ul class="current">
  38. <li class="toctree-l1">
  39. <a class="" href="..">Home</a>
  40. </li>
  41. <li class="toctree-l1">
  42. <span class="caption-text">Setup</span>
  43. <ul class="subnav">
  44. <li class="">
  45. <a class="" href="../Download-and-Installation/">Download and Installation</a>
  46. </li>
  47. <li class="">
  48. <a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
  49. </li>
  50. <li class=" current">
  51. <a class="current" href="./">Server requirements</a>
  52. <ul class="subnav">
  53. <li class="toctree-l3"><a href="#php">PHP</a></li>
  54. <ul>
  55. <li><a class="toctree-l4" href="#release-information">Release information</a></li>
  56. <li><a class="toctree-l4" href="#supported-versions">Supported versions</a></li>
  57. <li><a class="toctree-l4" href="#dependency-management">Dependency management</a></li>
  58. <li><a class="toctree-l4" href="#extensions">Extensions</a></li>
  59. </ul>
  60. </ul>
  61. </li>
  62. <li class="">
  63. <a class="" href="../Server-configuration/">Server configuration</a>
  64. </li>
  65. <li class="">
  66. <a class="" href="../Server-security/">Server security</a>
  67. </li>
  68. <li class="">
  69. <a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
  70. </li>
  71. <li class="">
  72. <a class="" href="../Plugins/">Plugins</a>
  73. </li>
  74. </ul>
  75. </li>
  76. <li class="toctree-l1">
  77. <span class="caption-text">Docker</span>
  78. <ul class="subnav">
  79. <li class="">
  80. <a class="" href="../docker/docker-101/">Docker 101</a>
  81. </li>
  82. <li class="">
  83. <a class="" href="../docker/shaarli-images/">Shaarli images</a>
  84. </li>
  85. <li class="">
  86. <a class="" href="../docker/reverse-proxy-configuration/">Reverse proxy configuration</a>
  87. </li>
  88. <li class="">
  89. <a class="" href="../docker/resources/">Docker resources</a>
  90. </li>
  91. </ul>
  92. </li>
  93. <li class="toctree-l1">
  94. <span class="caption-text">Usage</span>
  95. <ul class="subnav">
  96. <li class="">
  97. <a class="" href="../Features/">Features</a>
  98. </li>
  99. <li class="">
  100. <a class="" href="../Bookmarklet/">Bookmarklet</a>
  101. </li>
  102. <li class="">
  103. <a class="" href="../Browsing-and-searching/">Browsing and searching</a>
  104. </li>
  105. <li class="">
  106. <a class="" href="../Firefox-share/">Firefox share</a>
  107. </li>
  108. <li class="">
  109. <a class="" href="../RSS-feeds/">RSS feeds</a>
  110. </li>
  111. <li class="">
  112. <a class="" href="../REST-API/">REST API</a>
  113. </li>
  114. </ul>
  115. </li>
  116. <li class="toctree-l1">
  117. <span class="caption-text">How To</span>
  118. <ul class="subnav">
  119. <li class="">
  120. <a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
  121. </li>
  122. <li class="">
  123. <a class="" href="../Various-hacks/">Various hacks</a>
  124. </li>
  125. </ul>
  126. </li>
  127. <li class="toctree-l1">
  128. <a class="" href="../Troubleshooting/">Troubleshooting</a>
  129. </li>
  130. <li class="toctree-l1">
  131. <span class="caption-text">Development</span>
  132. <ul class="subnav">
  133. <li class="">
  134. <a class="" href="../Development-guidelines/">Development guidelines</a>
  135. </li>
  136. <li class="">
  137. <a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
  138. </li>
  139. <li class="">
  140. <a class="" href="../GnuPG-signature/">GnuPG signature</a>
  141. </li>
  142. <li class="">
  143. <a class="" href="../Coding-guidelines/">Coding guidelines</a>
  144. </li>
  145. <li class="">
  146. <a class="" href="../Directory-structure/">Directory structure</a>
  147. </li>
  148. <li class="">
  149. <a class="" href="../3rd-party-libraries/">3rd party libraries</a>
  150. </li>
  151. <li class="">
  152. <a class="" href="../Plugin-System/">Plugin System</a>
  153. </li>
  154. <li class="">
  155. <a class="" href="../Release-Shaarli/">Release Shaarli</a>
  156. </li>
  157. <li class="">
  158. <a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
  159. </li>
  160. <li class="">
  161. <a class="" href="../Security/">Security</a>
  162. </li>
  163. <li class="">
  164. <a class="" href="../Static-analysis/">Static analysis</a>
  165. </li>
  166. <li class="">
  167. <a class="" href="../Theming/">Theming</a>
  168. </li>
  169. <li class="">
  170. <a class="" href="../Unit-tests/">Unit tests</a>
  171. </li>
  172. </ul>
  173. </li>
  174. <li class="toctree-l1">
  175. <span class="caption-text">About</span>
  176. <ul class="subnav">
  177. <li class="">
  178. <a class="" href="../FAQ/">FAQ</a>
  179. </li>
  180. <li class="">
  181. <a class="" href="../Community-&-Related-software/">Community & Related software</a>
  182. </li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </div>
  187. &nbsp;
  188. </nav>
  189. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  190. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  191. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  192. <a href="..">Shaarli Documentation</a>
  193. </nav>
  194. <div class="wy-nav-content">
  195. <div class="rst-content">
  196. <div role="navigation" aria-label="breadcrumbs navigation">
  197. <ul class="wy-breadcrumbs">
  198. <li><a href="..">Docs</a> &raquo;</li>
  199. <li>Setup &raquo;</li>
  200. <li>Server requirements</li>
  201. <li class="wy-breadcrumbs-aside">
  202. <a href="https://github.com/shaarli/Shaarli/edit/master/docs/Server-requirements.md"
  203. class="icon icon-github"> Edit on GitHub</a>
  204. </li>
  205. </ul>
  206. <hr/>
  207. </div>
  208. <div role="main">
  209. <div class="section">
  210. <h2 id="php">PHP</h2>
  211. <h3 id="release-information">Release information</h3>
  212. <ul>
  213. <li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a></li>
  214. <li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em></li>
  215. <li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a></li>
  216. <li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a></li>
  217. <li><a href="https://bugs.php.net/">PHP: Bugs</a></li>
  218. </ul>
  219. <h3 id="supported-versions">Supported versions</h3>
  220. <table>
  221. <thead>
  222. <tr>
  223. <th align="center">Version</th>
  224. <th align="center">Status</th>
  225. <th align="center">Shaarli compatibility</th>
  226. </tr>
  227. </thead>
  228. <tbody>
  229. <tr>
  230. <td align="center">7.1</td>
  231. <td align="center">Supported (v0.9.x)</td>
  232. <td align="center">:white_check_mark:</td>
  233. </tr>
  234. <tr>
  235. <td align="center">7.0</td>
  236. <td align="center">Supported</td>
  237. <td align="center">:white_check_mark:</td>
  238. </tr>
  239. <tr>
  240. <td align="center">5.6</td>
  241. <td align="center">Supported</td>
  242. <td align="center">:white_check_mark:</td>
  243. </tr>
  244. <tr>
  245. <td align="center">5.5</td>
  246. <td align="center">EOL: 2016-07-10</td>
  247. <td align="center">:white_check_mark:</td>
  248. </tr>
  249. <tr>
  250. <td align="center">5.4</td>
  251. <td align="center">EOL: 2015-09-14</td>
  252. <td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td>
  253. </tr>
  254. <tr>
  255. <td align="center">5.3</td>
  256. <td align="center">EOL: 2014-08-14</td>
  257. <td align="center">:white_check_mark: (up to Shaarli 0.8.x)</td>
  258. </tr>
  259. </tbody>
  260. </table>
  261. <p>See also:
  262. - <a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a></p>
  263. <h3 id="dependency-management">Dependency management</h3>
  264. <p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve,
  265. download and install third-party PHP dependencies.</p>
  266. <table>
  267. <thead>
  268. <tr>
  269. <th>Library</th>
  270. <th align="center">Required?</th>
  271. <th>Usage</th>
  272. </tr>
  273. </thead>
  274. <tbody>
  275. <tr>
  276. <td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td>
  277. <td align="center">All</td>
  278. <td>Import bookmarks from Netscape files</td>
  279. </tr>
  280. <tr>
  281. <td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td>
  282. <td align="center">All</td>
  283. <td>Parse MarkDown syntax for the MarkDown plugin</td>
  284. </tr>
  285. <tr>
  286. <td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td>
  287. <td align="center">All</td>
  288. <td>Handle routes and middleware for the REST API</td>
  289. </tr>
  290. </tbody>
  291. </table>
  292. <h3 id="extensions">Extensions</h3>
  293. <table>
  294. <thead>
  295. <tr>
  296. <th>Extension</th>
  297. <th align="center">Required?</th>
  298. <th>Usage</th>
  299. </tr>
  300. </thead>
  301. <tbody>
  302. <tr>
  303. <td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td>
  304. <td align="center">All</td>
  305. <td>OpenSSL, HTTPS</td>
  306. </tr>
  307. <tr>
  308. <td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td>
  309. <td align="center">CentOS, Fedora, RHEL, Windows</td>
  310. <td>multibyte (Unicode) string support</td>
  311. </tr>
  312. <tr>
  313. <td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td>
  314. <td align="center">optional</td>
  315. <td>thumbnail resizing</td>
  316. </tr>
  317. <tr>
  318. <td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td>
  319. <td align="center">optional</td>
  320. <td>localized text sorting (e.g. <code>e-&gt;è-&gt;f</code>)</td>
  321. </tr>
  322. <tr>
  323. <td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td>
  324. <td align="center">optional</td>
  325. <td>using cURL for fetching webpages and thumbnails in a more robust way</td>
  326. </tr>
  327. </tbody>
  328. </table>
  329. </div>
  330. </div>
  331. <footer>
  332. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  333. <a href="../Server-configuration/" class="btn btn-neutral float-right" title="Server configuration">Next <span class="icon icon-circle-arrow-right"></span></a>
  334. <a href="../Upgrade-and-migration/" class="btn btn-neutral" title="Upgrade and migration"><span class="icon icon-circle-arrow-left"></span> Previous</a>
  335. </div>
  336. <hr/>
  337. <div role="contentinfo">
  338. <!-- Copyright etc -->
  339. </div>
  340. 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>.
  341. </footer>
  342. </div>
  343. </div>
  344. </section>
  345. </div>
  346. <div class="rst-versions" role="note" style="cursor: pointer">
  347. <span class="rst-current-version" data-toggle="rst-current-version">
  348. <a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
  349. <span><a href="../Upgrade-and-migration/" style="color: #fcfcfc;">&laquo; Previous</a></span>
  350. <span style="margin-left: 15px"><a href="../Server-configuration/" style="color: #fcfcfc">Next &raquo;</a></span>
  351. </span>
  352. </div>
  353. <script src="../js/theme.js"></script>
  354. </body>
  355. </html>