[github/shaarli/Shaarli.git] / doc / Server-configuration.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 configuration</title>
  <style type="text/css">code{white-space: pre;}</style>
  <style type="text/css">
div.sourceCode { overflow-x: auto; }
table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
  margin: 0; padding: 0; vertical-align: baseline; border: none; }
table.sourceCode { width: 100%; line-height: 100%; }
td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
td.sourceCode { padding-left: 5px; }
code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
code > span.dt { color: #902000; } /* DataType */
code > span.dv { color: #40a070; } /* DecVal */
code > span.bn { color: #40a070; } /* BaseN */
code > span.fl { color: #40a070; } /* Float */
code > span.ch { color: #4070a0; } /* Char */
code > span.st { color: #4070a0; } /* String */
code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
code > span.ot { color: #007020; } /* Other */
code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
code > span.fu { color: #06287e; } /* Function */
code > span.er { color: #ff0000; font-weight: bold; } /* Error */
code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
code > span.cn { color: #880000; } /* Constant */
code > span.sc { color: #4070a0; } /* SpecialChar */
code > span.vs { color: #4070a0; } /* VerbatimString */
code > span.ss { color: #bb6688; } /* SpecialString */
code > span.im { } /* Import */
code > span.va { color: #19177c; } /* Variable */
code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code > span.op { color: #666666; } /* Operator */
code > span.bu { } /* BuiltIn */
code > span.ex { } /* Extension */
code > span.pp { color: #bc7a00; } /* Preprocessor */
code > span.at { color: #7d9029; } /* Attribute */
code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
  </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-configuration">Server configuration</h1>
<p><em>Example virtual host configurations for popular web servers</em></p>
<ul>
<li><a href="#apache">Apache</a><a href=".html"></a></li>
<li><a href="#nginx">Nginx</a><a href=".html"></a></li>
</ul>
<h2 id="prerequisites">Prerequisites</h2>
<h3 id="shaarli">Shaarli</h3>
<ul>
<li>Shaarli is installed in a directory readable/writeable by the user</li>
<li>the correct read/write permissions have been granted to the web server <em>user and/or group</em></li>
<li>for HTTPS / SSL:</li>
<li>a key pair (public, private) and a certificate have been generated</li>
<li>the appropriate server SSL extension is installed and active</li>
</ul>
<h3 id="https-tls-and-self-signed-certificates">HTTPS, TLS and self-signed certificates</h3>
<p>Related guides:</p>
<ul>
<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>
<li><a href="https://workaround.org/certificate-authority">How do I create my own Certificate Authority?</a><a href=".html"></a></li>
<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>
</ul>
<h3 id="proxies">Proxies</h3>
<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>
<ul>
<li><code>X-Forwarded-Proto</code>;</li>
<li><code>X-Forwarded-Host</code>;</li>
<li><code>X-Forwarded-For</code>.</li>
</ul>
<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>
<h2 id="apache">Apache</h2>
<h3 id="minimal">Minimal</h3>
<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="at"> *:80</span><span class="fu">&gt;</span>
    ServerName<span class="st">   shaarli.my-domain.org</span>
    DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>
<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
<h3 id="debug---log-all-the-things">Debug - Log all the things!</h3>
<p>This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.</p>
<p>See:</p>
<ul>
<li><a href="http://stackoverflow.com/q/176">Apache/PHP - error log per VirtualHost</a> (StackOverflow)<a href=".html"></a></li>
<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>
</ul>
<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="at"> *:80</span><span class="fu">&gt;</span>
    ServerName<span class="st">   shaarli.my-domain.org</span>
    DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>

    <span class="ex">LogLevel</span><span class="ch">  </span><span class="kw">warn</span>
    ErrorLog<span class="st">  /var/log/apache2/shaarli-error.log</span>
    CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>

    php_flag  log_errors on
    php_flag  display_errors on
    php_value error_reporting 2147483647
    php_value error_log /var/log/apache2/shaarli-php-error.log
<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
<h3 id="standard---keep-access-and-error-logs">Standard - Keep access and error logs</h3>
<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="at"> *:80</span><span class="fu">&gt;</span>
    ServerName<span class="st">   shaarli.my-domain.org</span>
    DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>

    <span class="ex">LogLevel</span><span class="ch">  </span><span class="kw">warn</span>
    ErrorLog<span class="st">  /var/log/apache2/shaarli-error.log</span>
    CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
<h3 id="paranoid---redirect-http-80-to-https-443">Paranoid - Redirect HTTP (:80) to HTTPS (:443)</h3>
<p>See <a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Apache">Server-side TLS</a> (Mozilla).<a href=".html"></a></p>
<div class="sourceCode"><pre class="sourceCode apache"><code class="sourceCode apache"><span class="fu">&lt;VirtualHost</span><span class="at"> *:443</span><span class="fu">&gt;</span>
    ServerName<span class="st">   shaarli.my-domain.org</span>
    DocumentRoot<span class="st"> /absolute/path/to/shaarli/</span>

    <span class="ex">SSLEngine</span><span class="ch">             </span><span class="kw">on</span>
    SSLCertificateFile<span class="st">    /absolute/path/to/the/website/certificate.pem</span>
    SSLCertificateKeyFile<span class="st"> /absolute/path/to/the/website/key.key</span>

    <span class="fu">&lt;Directory</span><span class="at"> /absolute/path/to/shaarli/</span><span class="fu">&gt;</span>
        <span class="ex">AllowOverride</span><span class="ch"> </span><span class="kw">All</span>
        <span class="ex">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>
        <span class="ex">Order</span><span class="ch"> </span><span class="kw">allow,deny</span>
        allow<span class="st"> from all</span>
    <span class="fu">&lt;/Directory&gt;</span>

    <span class="ex">LogLevel</span><span class="ch">  </span><span class="kw">warn</span>
    ErrorLog<span class="st">  /var/log/apache2/shaarli-error.log</span>
    CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
<span class="fu">&lt;/VirtualHost&gt;</span>
<span class="fu">&lt;VirtualHost</span><span class="at"> *:80</span><span class="fu">&gt;</span>
    ServerName<span class="st">   shaarli.my-domain.org</span>
    Redirect<span class="st"> 301 / https://shaarli.my-domain.org</span>

    <span class="ex">LogLevel</span><span class="ch">  </span><span class="kw">warn</span>
    ErrorLog<span class="st">  /var/log/apache2/shaarli-error.log</span>
    CustomLog<span class="st"> /var/log/apache2/shaarli-access.log combined</span>
<span class="fu">&lt;/VirtualHost&gt;</span></code></pre></div>
<h3 id="htaccess">.htaccess</h3>
<p>Shaarli use <code>.htaccess</code> Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive <code>AllowOverride All</code> in your virtual host configuration for them to work.</p>
<p><strong>Warning</strong>: If you use Apache 2.2 or lower, you need <a href="https://httpd.apache.org/docs/current/mod/mod_version.html">mod_version</a> to be installed and enabled.<a href=".html"></a></p>
<p>Apache module <code>mod_rewrite</code> <strong>must</strong> be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root <code>.htaccess</code> file.</p>
<h2 id="lighthttpd">LightHttpd</h2>
<h2 id="nginx">Nginx</h2>
<h3 id="foreword">Foreword</h3>
<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>
<p>Required packages:</p>
<ul>
<li><a href="http://nginx.org">nginx</a><a href=".html"></a></li>
<li><a href="http://php-fpm.org">php-fpm</a> - PHP FastCGI Process Manager<a href=".html"></a></li>
</ul>
<p>Official documentation:</p>
<ul>
<li><a href="http://nginx.org/en/docs/beginners_guide.html">Beginner's guide</a><a href=".html"></a></li>
<li><a href="http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html">ngx_http_fastcgi_module</a><a href=".html"></a></li>
<li><a href="http://wiki.nginx.org/Pitfalls">Pitfalls</a><a href=".html"></a></li>
</ul>
<p>Community resources:</p>
<ul>
<li><a href="https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx">Server-side TLS (Nginx)</a> (Mozilla)<a href=".html"></a></li>
<li><a href="http://kbeezie.com/nginx-configuration-examples/">PHP configuration examples</a> (Karl Blessing)<a href=".html"></a></li>
</ul>
<h3 id="common-setup">Common setup</h3>
<p>Once Nginx and PHP-FPM are installed, we need to ensure:</p>
<ul>
<li>Nginx and PHP-FPM are running using the <em>same user and group</em></li>
<li>both these user and group have
<ul>
<li><code>read</code> permissions for Shaarli resources</li>
<li><code>execute</code> permissions for Shaarli directories <em>AND</em> their parent directories</li>
</ul></li>
</ul>
<p>On a production server:</p>
<ul>
<li><code>user:group</code> will likely be <code>http:http</code>, <code>www:www</code> or <code>www-data:www-data</code></li>
<li>files will be located under <code>/var/www</code>, <code>/var/http</code> or <code>/usr/share/nginx</code></li>
</ul>
<p>On a development server:</p>
<ul>
<li>files may be located in a user's home directory</li>
<li>in this case, make sure both Nginx and PHP-FPM are running as the local user/group!</li>
</ul>
<p>For all following configuration examples, this user/group pair will be used:</p>
<ul>
<li><code>user:group = john:users</code>,</li>
</ul>
<p>which corresponds to the following service configuration:</p>
<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co">; /etc/php/php-fpm.conf</span>
<span class="dt">user </span><span class="ot">=</span><span class="st"> john</span>
<span class="dt">group </span><span class="ot">=</span><span class="st"> users</span>

<span class="kw">[...][]</span><span class="dt">(.html)</span>
<span class="dt">listen.owner </span><span class="ot">=</span><span class="st"> john</span>
<span class="dt">listen.group </span><span class="ot">=</span><span class="st"> users</span></code></pre></div>
<pre class="nginx"><code># /etc/nginx/nginx.conf
user john users;

http {
    [...][](.html)
}</code></pre>
<h3 id="optional-increase-the-maximum-file-upload-size">(Optional) Increase the maximum file upload size</h3>
<p>Some bookmark dumps generated by web browsers can be <em>huge</em> due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.</p>
<p>To increase upload size, you will need to modify both nginx and PHP configuration:</p>
<pre class="nginx"><code># /etc/nginx/nginx.conf

http {
    [...][](.html)

    client_max_body_size 10m;

    [...][](.html)
}</code></pre>
<div class="sourceCode"><pre class="sourceCode ini"><code class="sourceCode ini"><span class="co"># /etc/php5/fpm/php.ini</span>

<span class="kw">[...][]</span><span class="dt">(.html)</span>
<span class="dt">post_max_size </span><span class="ot">=</span><span class="st"> 10M</span>
<span class="kw">[...][]</span><span class="dt">(.html)</span>
<span class="dt">upload_max_filesize </span><span class="ot">=</span><span class="st"> 10M</span></code></pre></div>
<h3 id="minimal-1">Minimal</h3>
<p><em>WARNING: Use for development only!</em></p>
<pre class="nginx"><code>user john users;
worker_processes  1;
events {
    worker_connections  1024;
}

http {
    include            mime.types;
    default_type       application/octet-stream;
    keepalive_timeout  20;

    index index.html index.php;

    server {
        listen       80;
        server_name  localhost;
        root         /home/john/web;

        access_log  /var/log/nginx/access.log;
        error_log   /var/log/nginx/error.log;

        location /shaarli/ {
            try_files $uri /shaarli/index.php$is_args$args;
            access_log  /var/log/nginx/shaarli.access.log;
            error_log   /var/log/nginx/shaarli.error.log;
        }

        location ~ (index)\.php$ {
            try_files $uri =404;
            fastcgi_split_path_info ^(.+\.php)(/.+)$;
            fastcgi_pass   unix:/var/run/php-fpm/php-fpm.sock;
            fastcgi_index  index.php;
            include        fastcgi.conf;
        }
    }
}</code></pre>
<h3 id="modular">Modular</h3>
<p>The previous setup is sufficient for development purposes, but has several major caveats:</p>
<ul>
<li>every content that does not match the PHP rule will be sent to client browsers:
<ul>
<li>dotfiles - in our case, <code>.htaccess</code></li>
<li>temporary files, e.g. Vim or Emacs files: <code>index.php~</code></li>
</ul></li>
<li>asset / static resource caching is not optimized</li>
<li>if serving several PHP sites, there will be a lot of duplication: <code>location /shaarli/</code>, <code>location /mysite/</code>, etc.</li>
</ul>
<p>To solve this, we will split Nginx configuration in several parts, that will be included when needed:</p>
<pre class="nginx"><code># /etc/nginx/deny.conf
location ~ /\. {
    # deny access to dotfiles
    access_log off;
    log_not_found off;
    deny all;
}

location ~ ~$ {
    # deny access to temp editor files, e.g. &quot;script.php~&quot;
    access_log off;
    log_not_found off;
    deny all;
}</code></pre>
<pre class="nginx"><code># /etc/nginx/php.conf
location ~ (index)\.php$ {
    # Slim - split URL path into (script_filename, path_info)
    try_files $uri =404;
    fastcgi_split_path_info ^(.+\.php)(/.+)$;

    # filter and proxy PHP requests to PHP-FPM
    fastcgi_pass   unix:/var/run/php-fpm/php-fpm.sock;
    fastcgi_index  index.php;
    include        fastcgi.conf;
}

location ~ \.php$ {
    # deny access to all other PHP scripts
    deny all;
}</code></pre>
<pre class="nginx"><code># /etc/nginx/static_assets.conf
location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
    expires    max;
    add_header Pragma public;
    add_header Cache-Control &quot;public, must-revalidate, proxy-revalidate&quot;;
}</code></pre>
<pre class="nginx"><code># /etc/nginx/nginx.conf
[...][](.html)

http {
    [...][](.html)

    root        /home/john/web;
    access_log  /var/log/nginx/access.log;
    error_log   /var/log/nginx/error.log;

    server {
        # virtual host for a first domain
        listen       80;
        server_name  my.first.domain.org;

        location /shaarli/ {
            # Slim - rewrite URLs
            try_files $uri /shaarli/index.php$is_args$args;

            access_log  /var/log/nginx/shaarli.access.log;
            error_log   /var/log/nginx/shaarli.error.log;
        }

        location = /shaarli/favicon.ico {
            # serve the Shaarli favicon from its custom location
            alias /var/www/shaarli/images/favicon.ico;
        }

        include deny.conf;
        include static_assets.conf;
        include php.conf;
    }

    server {
        # virtual host for a second domain
        listen       80;
        server_name  second.domain.com;

        location /minigal/ {
            access_log  /var/log/nginx/minigal.access.log;
            error_log   /var/log/nginx/minigal.error.log;
        }

        include deny.conf;
        include static_assets.conf;
        include php.conf;
    }
}</code></pre>
<h3 id="redirect-http-to-https">Redirect HTTP to HTTPS</h3>
<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>
<pre class="nginx"><code># /etc/nginx/nginx.conf
[...][](.html)

http {
    [...][](.html)

    index index.html index.php;

    root        /home/john/web;
    access_log  /var/log/nginx/access.log;
    error_log   /var/log/nginx/error.log;

    server {
        listen       80;
        server_name  localhost;

        return 301 https://localhost$request_uri;
    }

    server {
        listen       443 ssl;
        server_name  localhost;

        ssl_certificate      /home/john/ssl/localhost.crt;
        ssl_certificate_key  /home/john/ssl/localhost.key;

        location /shaarli/ {
            # Slim - rewrite URLs
            try_files $uri /index.php$is_args$args;

            access_log  /var/log/nginx/shaarli.access.log;
            error_log   /var/log/nginx/shaarli.error.log;
        }

        location = /shaarli/favicon.ico {
            # serve the Shaarli favicon from its custom location
            alias /var/www/shaarli/images/favicon.ico;
        }

        include deny.conf;
        include static_assets.conf;
        include php.conf;
    }
}</code></pre>
</body>
</html>