aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Server-requirements.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/Server-requirements.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/Server-requirements.html')
-rw-r--r--doc/Server-requirements.html195
1 files changed, 0 insertions, 195 deletions
diff --git a/doc/Server-requirements.html b/doc/Server-requirements.html
deleted file mode 100644
index 79d74118..00000000
--- a/doc/Server-requirements.html
+++ /dev/null
@@ -1,195 +0,0 @@
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">
7 <title>Shaarli – Server requirements</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <link rel="stylesheet" href="github-markdown.css">
10 <!--[if lt IE 9]>
11 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12 <![endif]-->
13</head>
14<body>
15<div id="local-sidebar">
16<ul>
17<li><a href="Home.html">Home</a></li>
18<li>Setup
19<ul>
20<li><a href="Download-and-Installation.html">Download and Installation</a></li>
21<li><a href="Upgrade-and-migration.html">Upgrade and migration</a></li>
22<li><a href="Server-requirements.html">Server requirements</a></li>
23<li><a href="Server-configuration.html">Server configuration</a></li>
24<li><a href="Server-security.html">Server security</a></li>
25<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
26<li><a href="Plugins.html">Plugins</a></li>
27</ul></li>
28<li><a href="Docker.html">Docker</a></li>
29<li><a href="Usage.html">Usage</a>
30<ul>
31<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
32<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
33<li><a href="Firefox-share.html">Firefox share</a></li>
34<li><a href="RSS-feeds.html">RSS feeds</a></li>
35<li><a href="REST-API.html">REST API</a></li>
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>
41<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
42<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
43<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
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>
53<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
54<li><a href="Versioning-and-Branches.html">Versioning and Branches</a></li>
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-&amp;-Related-software.html">Community &amp; Related software</a></li>
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>
73<li><a href="http://php.net/ChangeLog-7.php">PHP 7 Changelog</a><a href=".html"></a></li>
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">
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">
93<td style="text-align: center;">7.0</td>
94<td style="text-align: center;">Supported</td>
95<td style="text-align: center;">✅</td>
96</tr>
97<tr class="odd">
98<td style="text-align: center;">5.6</td>
99<td style="text-align: center;">Supported</td>
100<td style="text-align: center;">✅</td>
101</tr>
102<tr class="even">
103<td style="text-align: center;">5.5</td>
104<td style="text-align: center;">EOL: 2016-07-10</td>
105<td style="text-align: center;">✅</td>
106</tr>
107<tr class="odd">
108<td style="text-align: center;">5.4</td>
109<td style="text-align: center;">EOL: 2015-09-14</td>
110<td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td>
111</tr>
112<tr class="even">
113<td style="text-align: center;">5.3</td>
114<td style="text-align: center;">EOL: 2014-08-14</td>
115<td style="text-align: center;">✅ (up to Shaarli 0.8.x)</td>
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>
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 />
125download 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>
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>
150</tbody>
151</table>
152<h3 id="extensions">Extensions</h3>
153<table style="width:19%;">
154<colgroup>
155<col style="width: 5%" />
156<col style="width: 8%" />
157<col style="width: 5%" />
158</colgroup>
159<thead>
160<tr class="header">
161<th>Extension</th>
162<th style="text-align: center;">Required?</th>
163<th>Usage</th>
164</tr>
165</thead>
166<tbody>
167<tr class="odd">
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>
171</tr>
172<tr class="even">
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>
179<td style="text-align: center;">optional</td>
180<td>thumbnail resizing<a href=".html"></a></td>
181</tr>
182<tr class="even">
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-&gt;è-&gt;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>
191</tr>
192</tbody>
193</table>
194</body>
195</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-13 11:05:22 +0000