[github/shaarli/Shaarli.git] / doc / Server-requirements.html

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title>Shaarli – Server requirements</title>
  <style type="text/css">code{white-space: pre;}</style>
  <link rel="stylesheet" href="github-markdown.css">
  <!--[if lt IE 9]>
    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
  <![endif]-->
</head>
<body>
<div id="local-sidebar">
<ul>
<li><a href="Home.html">Home</a></li>
<li>Setup
<ul>
<li><a href="Download-and-Installation.html">Download and Installation</a></li>
<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
<li><a href="Server-requirements.html">Server requirements</a></li>
<li><a href="Server-configuration.html">Server configuration</a></li>
<li><a href="Server-security.html">Server security</a></li>
<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
<li><a href="Plugins.html">Plugins</a></li>
</ul></li>
<li><a href="Docker.html">Docker</a></li>
<li><a href="Usage.html">Usage</a>
<ul>
<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
<li><a href="Firefox-share.html">Firefox share</a></li>
<li><a href="RSS-feeds.html">RSS feeds</a></li>
<li><a href="REST-API.html">REST API</a></li>
</ul></li>
<li>How To
<ul>
<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
</ul></li>
<li><a href="Troubleshooting.html">Troubleshooting</a></li>
<li><a href="Development.html">Development</a>
<ul>
<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
<li><a href="Directory-structure.html">Directory structure</a></li>
<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
<li><a href="Plugin-System.html">Plugin System</a></li>
<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
<li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li>
<li><a href="Security.html">Security</a></li>
<li><a href="Static-analysis.html">Static analysis</a></li>
<li><a href="Theming.html">Theming</a></li>
<li><a href="Unit-tests.html">Unit tests</a></li>
</ul></li>
<li>About
<ul>
<li><a href="FAQ.html">FAQ</a></li>
<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
</ul></li>
</ul>
</div>
<h1 id="server-requirements">Server requirements</h1>
<h2 id="php">PHP</h2>
<h3 id="release-information">Release information</h3>
<ul>
<li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a><a href=".html"></a></li>
<li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em><a href=".html"></a></li>
<li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a><a href=".html"></a></li>
<li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a><a href=".html"></a></li>
<li><a href="https://bugs.php.net/">PHP: Bugs</a><a href=".html"></a></li>
</ul>
<h3 id="supported-versions">Supported versions</h3>
<table>
<thead>
<tr class="header">
<th style="text-align: center;">Version</th>
<th style="text-align: center;">Status</th>
<th style="text-align: center;">Shaarli compatibility</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: center;">7.1</td>
<td style="text-align: center;">Supported (v0.9.x)</td>
<td style="text-align: center;">✅</td>
</tr>
<tr class="even">
<td style="text-align: center;">7.0</td>
<td style="text-align: center;">Supported</td>
<td style="text-align: center;">✅</td>
</tr>
<tr class="odd">
<td style="text-align: center;">5.6</td>
<td style="text-align: center;">Supported</td>
<td style="text-align: center;">✅</td>
</tr>
<tr class="even">
<td style="text-align: center;">5.5</td>
<td style="text-align: center;">EOL: 2016-07-10</td>
<td style="text-align: center;">✅</td>
</tr>
<tr class="odd">
<td style="text-align: center;">5.4</td>
<td style="text-align: center;">EOL: 2015-09-14</td>
<td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td>
</tr>
<tr class="even">
<td style="text-align: center;">5.3</td>
<td style="text-align: center;">EOL: 2014-08-14</td>
<td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td>
</tr>
</tbody>
</table>
<p>See also:</p>
<ul>
<li><a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a><a href=".html"></a></li>
</ul>
<h3 id="dependency-management">Dependency management</h3>
<p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve,<a href=".html"></a><br />
download and install third-party PHP dependencies.</p>
<table>
<thead>
<tr class="header">
<th>Library</th>
<th style="text-align: center;">Required?</th>
<th>Usage</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td>
<td style="text-align: center;">All</td>
<td>Import bookmarks from Netscape files<a href=".html"></a></td>
</tr>
<tr class="even">
<td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td>
<td style="text-align: center;">All</td>
<td>Parse MarkDown syntax for the MarkDown plugin<a href=".html"></a></td>
</tr>
<tr class="odd">
<td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td>
<td style="text-align: center;">All</td>
<td>Handle routes and middleware for the REST API<a href=".html"></a></td>
</tr>
</tbody>
</table>
<h3 id="extensions">Extensions</h3>
<table style="width:19%;">
<colgroup>
<col style="width: 5%" />
<col style="width: 8%" />
<col style="width: 5%" />
</colgroup>
<thead>
<tr class="header">
<th>Extension</th>
<th style="text-align: center;">Required?</th>
<th>Usage</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td>
<td style="text-align: center;">All</td>
<td>OpenSSL, HTTPS<a href=".html"></a></td>
</tr>
<tr class="even">
<td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td>
<td style="text-align: center;">CentOS, Fedora, RHEL, Windows</td>
<td>multibyte (Unicode) string support<a href=".html"></a></td>
</tr>
<tr class="odd">
<td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td>
<td style="text-align: center;">optional</td>
<td>thumbnail resizing<a href=".html"></a></td>
</tr>
<tr class="even">
<td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td>
<td style="text-align: center;">optional</td>
<td>localized text sorting (e.g. <code>e-&gt;è-&gt;f</code>)<a href=".html"></a></td>
</tr>
<tr class="odd">
<td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td>
<td style="text-align: center;">optional</td>
<td>using cURL for fetching webpages and thumbnails in a more robust way<a href=".html"></a></td>
</tr>
</tbody>
</table>
</body>
</html>
Commit	Line	Data
992af0b9 V	1	<!DOCTYPE html>
	2	<html>
	3	<head>
	4	<meta charset="utf-8">
	5	<meta name="generator" content="pandoc">
	6	<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
5409ade2	7	<title>Shaarli – Server requirements</title>
992af0b9	8	<style type="text/css">code{white-space: pre;}</style>
5409ade2	9	<link rel="stylesheet" href="github-markdown.css">
992af0b9	10	<!--[if lt IE 9]>
5409ade2	11	<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
992af0b9	12	<![endif]-->
992af0b9 V	13	</head>
	14	<body>
	15	<div id="local-sidebar">
	16	<ul>
	17	<li><a href="Home.html">Home</a></li>
fdf88d19	18	<li>Setup
992af0b9	19	<ul>
fdf88d19 A	20	<li><a href="Download-and-Installation.html">Download and Installation</a></li>
fdf88d19 A	21	<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
992af0b9 V	22	<li><a href="Server-requirements.html">Server requirements</a></li>
992af0b9 V	23	<li><a href="Server-configuration.html">Server configuration</a></li>
5409ade2	24	<li><a href="Server-security.html">Server security</a></li>
992af0b9	25	<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
08dcd8ea	26	<li><a href="Plugins.html">Plugins</a></li>
992af0b9	27	</ul></li>
5409ade2	28	<li><a href="Docker.html">Docker</a></li>
992af0b9 V	29	<li><a href="Usage.html">Usage</a>
	30	<ul>
	31	<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
5409ade2	32	<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
992af0b9 V	33	<li><a href="Firefox-share.html">Firefox share</a></li>
992af0b9 V	34	<li><a href="RSS-feeds.html">RSS feeds</a></li>
b230bf20	35	<li><a href="REST-API.html">REST API</a></li>
992af0b9 V	36	</ul></li>
	37	<li>How To
	38	<ul>
	39	<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
	40	<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
5409ade2	41	<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
992af0b9	42	<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
6335a0fc	43	<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
992af0b9 V	44	</ul></li>
	45	<li><a href="Troubleshooting.html">Troubleshooting</a></li>
	46	<li><a href="Development.html">Development</a>
	47	<ul>
	48	<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
	49	<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
	50	<li><a href="Directory-structure.html">Directory structure</a></li>
	51	<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
	52	<li><a href="Plugin-System.html">Plugin System</a></li>
5409ade2	53	<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
b230bf20	54	<li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li>
992af0b9 V	55	<li><a href="Security.html">Security</a></li>
	56	<li><a href="Static-analysis.html">Static analysis</a></li>
	57	<li><a href="Theming.html">Theming</a></li>
	58	<li><a href="Unit-tests.html">Unit tests</a></li>
	59	</ul></li>
	60	<li>About
	61	<ul>
	62	<li><a href="FAQ.html">FAQ</a></li>
	63	<li><a href="Community-&-Related-software.html">Community & Related software</a></li>
992af0b9 V	64	</ul></li>
	65	</ul>
	66	</div>
	67	<h1 id="server-requirements">Server requirements</h1>
	68	<h2 id="php">PHP</h2>
	69	<h3 id="release-information">Release information</h3>
	70	<ul>
	71	<li><a href="http://php.net/supported-versions.php">PHP: Supported versions</a><a href=".html"></a></li>
	72	<li><a href="http://php.net/eol.php">PHP: Unsupported versions</a> <em>(EOL - End Of Life)</em><a href=".html"></a></li>
5409ade2	73	<li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a><a href=".html"></a></li>
992af0b9 V	74	<li><a href="http://php.net/ChangeLog-5.php">PHP 5 Changelog</a><a href=".html"></a></li>
	75	<li><a href="https://bugs.php.net/">PHP: Bugs</a><a href=".html"></a></li>
	76	</ul>
	77	<h3 id="supported-versions">Supported versions</h3>
	78	<table>
	79	<thead>
	80	<tr class="header">
	81	<th style="text-align: center;">Version</th>
	82	<th style="text-align: center;">Status</th>
	83	<th style="text-align: center;">Shaarli compatibility</th>
	84	</tr>
	85	</thead>
	86	<tbody>
	87	<tr class="odd">
b230bf20 A	88	<td style="text-align: center;">7.1</td>
	89	<td style="text-align: center;">Supported (v0.9.x)</td>
	90	<td style="text-align: center;">✅</td>
	91	</tr>
	92	<tr class="even">
5409ade2 A	93	<td style="text-align: center;">7.0</td>
	94	<td style="text-align: center;">Supported</td>
	95	<td style="text-align: center;">✅</td>
f8b936e7	96	</tr>
b230bf20	97	<tr class="odd">
992af0b9 V	98	<td style="text-align: center;">5.6</td>
992af0b9 V	99	<td style="text-align: center;">Supported</td>
5409ade2	100	<td style="text-align: center;">✅</td>
992af0b9	101	</tr>
b230bf20	102	<tr class="even">
992af0b9	103	<td style="text-align: center;">5.5</td>
fdf88d19	104	<td style="text-align: center;">EOL: 2016-07-10</td>
5409ade2	105	<td style="text-align: center;">✅</td>
992af0b9	106	</tr>
b230bf20	107	<tr class="odd">
992af0b9	108	<td style="text-align: center;">5.4</td>
f8b936e7	109	<td style="text-align: center;">EOL: 2015-09-14</td>
fdf88d19	110	<td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td>
992af0b9	111	</tr>
b230bf20	112	<tr class="even">
992af0b9 V	113	<td style="text-align: center;">5.3</td>
992af0b9 V	114	<td style="text-align: center;">EOL: 2014-08-14</td>
fdf88d19	115	<td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td>
992af0b9 V	116	</tr>
	117	</tbody>
	118	</table>
	119	<p>See also:</p>
	120	<ul>
	121	<li><a href="https://github.com/shaarli/Shaarli/blob/master/.travis.yml">Travis configuration</a><a href=".html"></a></li>
	122	</ul>
fdf88d19 A	123	<h3 id="dependency-management">Dependency management</h3>
	124	<p>Starting with Shaarli <code>v0.8.x</code>, <a href="https://getcomposer.org/">Composer</a> is used to resolve,<a href=".html"></a><br />
	125	download and install third-party PHP dependencies.</p>
	126	<table>
	127	<thead>
	128	<tr class="header">
	129	<th>Library</th>
	130	<th style="text-align: center;">Required?</th>
	131	<th>Usage</th>
	132	</tr>
	133	</thead>
	134	<tbody>
	135	<tr class="odd">
	136	<td><a href="https://packagist.org/packages/shaarli/netscape-bookmark-parser"><code>shaarli/netscape-bookmark-parser</code></a></td>
	137	<td style="text-align: center;">All</td>
	138	<td>Import bookmarks from Netscape files<a href=".html"></a></td>
	139	</tr>
b230bf20 A	140	<tr class="even">
	141	<td><a href="https://packagist.org/packages/erusev/parsedown"><code>erusev/parsedown</code></a></td>
	142	<td style="text-align: center;">All</td>
	143	<td>Parse MarkDown syntax for the MarkDown plugin<a href=".html"></a></td>
	144	</tr>
	145	<tr class="odd">
	146	<td><a href="https://packagist.org/packages/slim/slim"><code>slim/slim</code></a></td>
	147	<td style="text-align: center;">All</td>
	148	<td>Handle routes and middleware for the REST API<a href=".html"></a></td>
	149	</tr>
fdf88d19 A	150	</tbody>
fdf88d19 A	151	</table>
992af0b9	152	<h3 id="extensions">Extensions</h3>
5409ade2 A	153	<table style="width:19%;">
	154	<colgroup>
	155	<col style="width: 5%" />
	156	<col style="width: 8%" />
	157	<col style="width: 5%" />
	158	</colgroup>
992af0b9 V	159	<thead>
992af0b9 V	160	<tr class="header">
5409ade2	161	<th>Extension</th>
992af0b9	162	<th style="text-align: center;">Required?</th>
5409ade2	163	<th>Usage</th>
992af0b9 V	164	</tr>
	165	</thead>
	166	<tbody>
	167	<tr class="odd">
5409ade2 A	168	<td><a href="http://php.net/manual/en/book.openssl.php"><code>openssl</code></a></td>
	169	<td style="text-align: center;">All</td>
	170	<td>OpenSSL, HTTPS<a href=".html"></a></td>
992af0b9 V	171	</tr>
992af0b9 V	172	<tr class="even">
5409ade2 A	173	<td><a href="http://php.net/manual/en/book.mbstring.php"><code>php-mbstring</code></a></td>
	174	<td style="text-align: center;">CentOS, Fedora, RHEL, Windows</td>
	175	<td>multibyte (Unicode) string support<a href=".html"></a></td>
	176	</tr>
	177	<tr class="odd">
	178	<td><a href="http://php.net/manual/en/book.image.php"><code>php-gd</code></a></td>
fdf88d19	179	<td style="text-align: center;">optional</td>
5409ade2 A	180	<td>thumbnail resizing<a href=".html"></a></td>
	181	</tr>
	182	<tr class="even">
fdf88d19 A	183	<td><a href="http://php.net/manual/en/book.intl.php"><code>php-intl</code></a></td>
	184	<td style="text-align: center;">optional</td>
	185	<td>localized text sorting (e.g. <code>e->è->f</code>)<a href=".html"></a></td>
	186	</tr>
	187	<tr class="odd">
	188	<td><a href="http://php.net/manual/en/book.curl.php"><code>php-curl</code></a></td>
	189	<td style="text-align: center;">optional</td>
	190	<td>using cURL for fetching webpages and thumbnails in a more robust way<a href=".html"></a></td>
992af0b9 V	191	</tr>
	192	</tbody>
	193	</table>
	194	</body>
	195	</html>