]> git.immae.eu Git - github/shaarli/Shaarli.git/blame_incremental - doc/Server-configuration.html
projects / github / shaarli / Shaarli.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Add a description to wallabag plugin parameters
[github/shaarli/Shaarli.git] / doc / Server-configuration.html
... / ...
CommitLineData
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 configuration</title>
8 <style type="text/css">code{white-space: pre;}</style>
9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
13table.sourceCode { width: 100%; line-height: 100%; }
14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
15td.sourceCode { padding-left: 5px; }
16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
17code > span.dt { color: #902000; } /* DataType */
18code > span.dv { color: #40a070; } /* DecVal */
19code > span.bn { color: #40a070; } /* BaseN */
20code > span.fl { color: #40a070; } /* Float */
21code > span.ch { color: #4070a0; } /* Char */
22code > span.st { color: #4070a0; } /* String */
23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
24code > span.ot { color: #007020; } /* Other */
25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
26code > span.fu { color: #06287e; } /* Function */
27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
45 </style>
46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
50</head>
51<body>
52<div id="local-sidebar">
53<ul>
54<li><a href="Home.html">Home</a></li>
55<li>Installation
56<ul>
57<li><a href="Download.html">Download</a></li>
58<li><a href="Server-requirements.html">Server requirements</a></li>
59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugins.html">Plugins</a></li>
64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Usage.html">Usage</a>
67<ul>
68<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
69<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
70<li><a href="Firefox-share.html">Firefox share</a></li>
71<li><a href="RSS-feeds.html">RSS feeds</a></li>
72</ul></li>
73<li>How To
74<ul>
75<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
76<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
77<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>
78<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
79<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
80<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
81</ul></li>
82<li><a href="Troubleshooting.html">Troubleshooting</a></li>
83<li><a href="Development.html">Development</a>
84<ul>
85<li><a href="GnuPG-signature.html">GnuPG signature</a></li>
86<li><a href="Coding-guidelines.html">Coding guidelines</a></li>
87<li><a href="Directory-structure.html">Directory structure</a></li>
88<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
89<li><a href="Plugin-System.html">Plugin System</a></li>
90<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
91<li><a href="Security.html">Security</a></li>
92<li><a href="Static-analysis.html">Static analysis</a></li>
93<li><a href="Theming.html">Theming</a></li>
94<li><a href="Unit-tests.html">Unit tests</a></li>
95</ul></li>
96<li>About
97<ul>
98<li><a href="FAQ.html">FAQ</a></li>
99<li><a href="Community-&amp;-Related-software.html">Community &amp; Related software</a></li>
100<li><a href="TODO.html">TODO</a></li>
101</ul></li>
102</ul>
103</div>
104<h1 id="server-configuration">Server configuration</h1>
105<p><em>Example virtual host configurations for popular web servers</em></p>
106<ul>
107<li><a href="#apache">Apache</a><a href=".html"></a></li>
108<li><a href="#nginx">Nginx</a><a href=".html"></a></li>
109</ul>
110<h2 id="prerequisites">Prerequisites</h2>
111<h3 id="shaarli">Shaarli</h3>
112<ul>
113<li>Shaarli is installed in a directory readable/writeable by the user</li>
114<li>the correct read/write permissions have been granted to the web server <em>user and/or group</em></li>
115<li>for HTTPS / SSL:</li>
116<li>a key pair (public, private) and a certificate have been generated</li>
117<li>the appropriate server SSL extension is installed and active</li>
118</ul>
119<h3 id="https-tls-and-self-signed-certificates">HTTPS, TLS and self-signed certificates</h3>
120<p>Related guides:</p>
121<ul>
122<li><a href="http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php">How to Create Self-Signed SSL Certificates with OpenSSL</a><a href=".html"></a></li>
123<li><a href="https://workaround.org/certificate-authority">How do I create my own Certificate Authority?</a><a href=".html"></a></li>
124<li>Generate a self-signed certificate (will trigger browser warnings) with apache2: <code>make-ssl-cert generate-default-snakeoil --force-overwrite</code> will create <code>/etc/ssl/certs/ssl-cert-snakeoil.pem</code> and <code>/etc/ssl/private/ssl-cert-snakeoil.key</code></li>
125</ul>
126<h3 id="proxies">Proxies</h3>
127<p>If Shaarli is served behind a proxy (i.e. there is a proxy server between clients and the web server hosting Shaarli), please refer to the proxy server documentation for proper configuration. In particular, you have to ensure that the following server variables are properly set:</p>
128<ul>
129<li><code>X-Forwarded-Proto</code>;</li>
130<li><code>X-Forwarded-Host</code>;</li>
131<li><code>X-Forwarded-For</code>.</li>
132</ul>
133<p>See also <a href="https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&amp;q=label%3Aproxy+">proxy-related</a> issues.<a href=".html"></a></p>
134<h2 id="apache">Apache</h2>
135<h3 id="minimal">Minimal</h3>
136<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
137 ServerName<span class="st"> shaarli.my-domain.org</span>
138 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
139<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
140<h3 id="debug---log-all-the-things">Debug - Log all the things!</h3>
141<p>This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.</p>
142<p>See:</p>
143<ul>
144<li><a href="http://stackoverflow.com/q/176">Apache/PHP - error log per VirtualHost</a> (StackOverflow)<a href=".html"></a></li>
145<li><a href="https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/">PHP: php_value vs php_admin_value and the use of php_flag explained</a><a href=".html"></a></li>
146</ul>
147<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
148 ServerName<span class="st"> shaarli.my-domain.org</span>
149 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
150
151 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span>
152 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span>
153 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
154
155 php_flag log_errors on
156 php_flag display_errors on
157 php_value error_reporting 2147483647
158 php_value error_log /var/log/apache2/shaarli-php-error.log
159<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
160<h3 id="standard---keep-access-and-error-logs">Standard - Keep access and error logs</h3>
161<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
162 ServerName<span class="st"> shaarli.my-domain.org</span>
163 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
164
165 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span>
166 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span>
167 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
168<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
169<h3 id="paranoid---redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</h3>
170<p>See <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Apache">Server-side TLS</a> (Mozilla).<a href=".html"></a></p>
171<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="ot"> *:443</span><span class="fu">&gt;</span>
172 ServerName<span class="st"> shaarli.my-domain.org</span>
173 DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
174
175 <span class="ot">SSLEngine</span><span class="ch"> </span><span class="kw">on</span>
176 SSLCertificateFile<span class="st"> /absolute/path/to/the/website/certificate.pem</span>
177 SSLCertificateKeyFile<span class="st"> /absolute/path/to/the/website/key.key</span>
178
179 <span class="fu">&lt;Directory</span><span class="ot"> /absolute/path/to/shaarli/</span><span class="fu">&gt;</span>
180 <span class="ot">AllowOverride</span><span class="ch"> </span><span class="kw">All</span>
181 <span class="ot">Options</span><span class="ch"> </span><span class="kw">Indexes</span><span class="ch"> </span><span class="kw">FollowSymLinks</span><span class="ch"> </span><span class="kw">MultiViews</span>
182 <span class="ot">Order</span><span class="ch"> </span><span class="kw">allow,deny</span>
183 allow<span class="st"> from all</span>
184 <span class="fu">&lt;/Directory&gt;</span>
185
186 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span>
187 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span>
188 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
189<span class="fu">&lt;/VirtualHost&gt;</span>
190<span class="fu">&lt;VirtualHost</span><span class="ot"> *:80</span><span class="fu">&gt;</span>
191 ServerName<span class="st"> shaarli.my-domain.org</span>
192 Redirect<span class="st"> 301 / https://shaarli.my-domain.org</span>
193
194 <span class="ot">LogLevel</span><span class="ch"> </span><span class="kw">warn</span>
195 ErrorLog<span class="st"> /var/log/apache2/shaarli-error.log</span>
196 CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
197<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
198<h2 id="lighthttpd">LightHttpd</h2>
199<h2 id="nginx">Nginx</h2>
200<h3 id="foreword">Foreword</h3>
201<p>Nginx does not natively interpret PHP scripts; to this effect, we will run a <a href="https://en.wikipedia.org/wiki/FastCGI">FastCGI</a> service, to which Nginx's FastCGI module will proxy all requests to PHP resources.<a href=".html"></a></p>
202<p>Required packages:</p>
203<ul>
204<li><a href="http://nginx.org">nginx</a><a href=".html"></a></li>
205<li><a href="http://php-fpm.org">php-fpm</a> - PHP FastCGI Process Manager<a href=".html"></a></li>
206</ul>
207<p>Official documentation:</p>
208<ul>
209<li><a href="http://nginx.org/en/docs/beginners_guide.html">Beginner's guide</a><a href=".html"></a></li>
210<li><a href="http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html">ngx_http_fastcgi_module</a><a href=".html"></a></li>
211<li><a href="http://wiki.nginx.org/Pitfalls">Pitfalls</a><a href=".html"></a></li>
212</ul>
213<p>Community resources:</p>
214<ul>
215<li><a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx">Server-side TLS (Nginx)</a> (Mozilla)<a href=".html"></a></li>
216<li><a href="http://kbeezie.com/nginx-configuration-examples/">PHP configuration examples</a> (Karl Blessing)<a href=".html"></a></li>
217</ul>
218<h3 id="common-setup">Common setup</h3>
219<p>Once Nginx and PHP-FPM are installed, we need to ensure:</p>
220<ul>
221<li>Nginx and PHP-FPM are running using the <em>same user and group</em></li>
222<li>both these user and group have
223<ul>
224<li><code>read</code> permissions for Shaarli resources</li>
225<li><code>execute</code> permissions for Shaarli directories <em>AND</em> their parent directories</li>
226</ul></li>
227</ul>
228<p>On a production server:</p>
229<ul>
230<li><code>user:group</code> will likely be <code>http:http</code>, <code>www:www</code> or <code>www-data:www-data</code></li>
231<li>files will be located under <code>/var/www</code>, <code>/var/http</code> or <code>/usr/share/nginx</code></li>
232</ul>
233<p>On a development server:</p>
234<ul>
235<li>files may be located in a user's home directory</li>
236<li>in this case, make sure both Nginx and PHP-FPM are running as the local user/group!</li>
237</ul>
238<p>For all following examples, a development configuration will be used:</p>
239<ul>
240<li><code>user:group = john:users</code>,</li>
241</ul>
242<p>which corresponds to the following service configuration:</p>
243<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co">; /etc/php/php-fpm.conf</span>
244<span class="dt">user </span><span class="ot">=</span><span class="st"> john</span>
245<span class="dt">group </span><span class="ot">=</span><span class="st"> users</span>
246
247<span class="kw">[...][]</span><span class="dt">(.html)</span>
248<span class="dt">listen.owner </span><span class="ot">=</span><span class="st"> john</span>
249<span class="dt">listen.group </span><span class="ot">=</span><span class="st"> users</span></code></pre></div>
250<pre class="nginx"><code># /etc/nginx/nginx.conf
251user john users;
252
253http {
254 [...][](.html)
255}</code></pre>
256<h3 id="minimal-1">Minimal</h3>
257<p><em>WARNING: Use for development only!</em></p>
258<pre class="nginx"><code>user john users;
259worker_processes 1;
260events {
261 worker_connections 1024;
262}
263
264http {
265 include mime.types;
266 default_type application/octet-stream;
267 keepalive_timeout 20;
268
269 index index.html index.php;
270
271 server {
272 listen 80;
273 server_name localhost;
274 root /home/john/web;
275
276 access_log /var/log/nginx/access.log;
277 error_log /var/log/nginx/error.log;
278
279 location /shaarli/ {
280 access_log /var/log/nginx/shaarli.access.log;
281 error_log /var/log/nginx/shaarli.error.log;
282 }
283
284 location ~ (index)\.php$ {
285 fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
286 fastcgi_index index.php;
287 include fastcgi.conf;
288 }
289 }
290}</code></pre>
291<h3 id="modular">Modular</h3>
292<p>The previous setup is sufficient for development purposes, but has several major caveats:</p>
293<ul>
294<li>every content that does not match the PHP rule will be sent to client browsers:
295<ul>
296<li>dotfiles - in our case, <code>.htaccess</code></li>
297<li>temporary files, e.g. Vim or Emacs files: <code>index.php~</code></li>
298</ul></li>
299<li>asset / static resource caching is not optimized</li>
300<li>if serving several PHP sites, there will be a lot of duplication: <code>location /shaarli/</code>, <code>location /mysite/</code>, etc.</li>
301</ul>
302<p>To solve this, we will split Nginx configuration in several parts, that will be included when needed:</p>
303<pre class="nginx"><code># /etc/nginx/deny.conf
304location ~ /\. {
305 # deny access to dotfiles
306 access_log off;
307 log_not_found off;
308 deny all;
309}
310
311location ~ ~$ {
312 # deny access to temp editor files, e.g. &quot;script.php~&quot;
313 access_log off;
314 log_not_found off;
315 deny all;
316}</code></pre>
317<pre class="nginx"><code># /etc/nginx/php.conf
318location ~ (index)\.php$ {
319 # filter and proxy PHP requests to PHP-FPM
320 fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
321 fastcgi_index index.php;
322 include fastcgi.conf;
323}
324
325location ~ \.php$ {
326 # deny access to all other PHP scripts
327 deny all;
328}</code></pre>
329<pre class="nginx"><code># /etc/nginx/static_assets.conf
330location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
331 expires max;
332 add_header Pragma public;
333 add_header Cache-Control &quot;public, must-revalidate, proxy-revalidate&quot;;
334}</code></pre>
335<pre class="nginx"><code># /etc/nginx/nginx.conf
336[...][](.html)
337
338http {
339 [...][](.html)
340
341 root /home/john/web;
342 access_log /var/log/nginx/access.log;
343 error_log /var/log/nginx/error.log;
344
345 server {
346 # virtual host for a first domain
347 listen 80;
348 server_name my.first.domain.org;
349
350 location /shaarli/ {
351 access_log /var/log/nginx/shaarli.access.log;
352 error_log /var/log/nginx/shaarli.error.log;
353 }
354
355 include deny.conf;
356 include static_assets.conf;
357 include php.conf;
358 }
359
360 server {
361 # virtual host for a second domain
362 listen 80;
363 server_name second.domain.com;
364
365 location /minigal/ {
366 access_log /var/log/nginx/minigal.access.log;
367 error_log /var/log/nginx/minigal.error.log;
368 }
369
370 include deny.conf;
371 include static_assets.conf;
372 include php.conf;
373 }
374}</code></pre>
375<h3 id="redirect-http-to-https">Redirect HTTP to HTTPS</h3>
376<p>Assuming you have generated a (self-signed) key and certificate, and they are located under <code>/home/john/ssl/localhost.{key,crt}</code>, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage.</p>
377<pre class="nginx"><code># /etc/nginx/nginx.conf
378[...][](.html)
379
380http {
381 [...][](.html)
382
383 index index.html index.php;
384
385 root /home/john/web;
386 access_log /var/log/nginx/access.log;
387 error_log /var/log/nginx/error.log;
388
389 server {
390 listen 80;
391 server_name localhost;
392
393 return 301 https://localhost$request_uri;
394 }
395
396 server {
397 listen 443 ssl;
398 server_name localhost;
399
400 ssl_certificate /home/john/ssl/localhost.crt;
401 ssl_certificate_key /home/john/ssl/localhost.key;
402
403 location /shaarli/ {
404 access_log /var/log/nginx/shaarli.access.log;
405 error_log /var/log/nginx/shaarli.error.log;
406 }
407
408 include deny.conf;
409 include static_assets.conf;
410 include php.conf;
411 }
412}</code></pre>
413<h2 id="restricting-search-engines-and-web-crawler-traffic">Restricting search engines and web crawler traffic</h2>
414<p>Creating a <code>robots.txt</code> witht he following contents at the root of your Shaarli installation will prevent &quot;honest&quot; web crawlers from indexing each and every link and Daily page from a Shaarli instance, thus getting rid of a certain amount of unsollicited network traffic.</p>
415<pre><code>User-agent: *
416Disallow: /</code></pre>
417<p>See: <a href="http://www.robotstxt.org/" class="uri">http://www.robotstxt.org/</a>, <a href="http://www.robotstxt.org/robotstxt.html" class="uri">http://www.robotstxt.org/robotstxt.html</a>, <a href="http://www.robotstxt.org/meta.html" class="uri">http://www.robotstxt.org/meta.html</a></p>
418</body>
419</html>
The personal, minimalist, super-fast, database free, bookmarking service - community repo