2 *Example virtual host configurations for popular web servers*
4 - [Apache](#apache)[](.html)
5 - [Nginx](#nginx)[](.html)
9 * Shaarli is installed in a directory readable/writeable by the user
10 * the correct read/write permissions have been granted to the web server _user and/or group_
12 * a key pair (public, private) and a certificate have been generated
13 * the appropriate server SSL extension is installed and active
15 ### HTTPS, TLS and self-signed certificates
17 * [How to Create Self-Signed SSL Certificates with OpenSSL](http://www.xenocafe.com/tutorials/linux/centos/openssl/self_signed_certificates/index.php)[](.html)
18 * [How do I create my own Certificate Authority?](https://workaround.org/certificate-authority)[](.html)
19 * Generate a self-signed certificate (will trigger browser warnings) with apache2: `make-ssl-cert generate-default-snakeoil --force-overwrite` will create `/etc/ssl/certs/ssl-cert-snakeoil.pem` and `/etc/ssl/private/ssl-cert-snakeoil.key`
22 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:
23 - `X-Forwarded-Proto`;
27 See also [proxy-related](https://github.com/shaarli/Shaarli/issues?utf8=%E2%9C%93&q=label%3Aproxy+) issues.[](.html)
33 ServerName shaarli.my-domain.org
34 DocumentRoot /absolute/path/to/shaarli/
37 ### Debug - Log all the things!
38 This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.
41 * [Apache/PHP - error log per VirtualHost](http://stackoverflow.com/q/176) (StackOverflow)[](.html)
42 * [PHP: php_value vs php_admin_value and the use of php_flag explained](https://ma.ttias.be/php-php_value-vs-php_admin_value-and-the-use-of-php_flag-explained/)[](.html)
46 ServerName shaarli.my-domain.org
47 DocumentRoot /absolute/path/to/shaarli/
50 ErrorLog /var/log/apache2/shaarli-error.log
51 CustomLog /var/log/apache2/shaarli-access.log combined
53 php_flag log_errors on
54 php_flag display_errors on
55 php_value error_reporting 2147483647
56 php_value error_log /var/log/apache2/shaarli-php-error.log
60 ### Standard - Keep access and error logs
63 ServerName shaarli.my-domain.org
64 DocumentRoot /absolute/path/to/shaarli/
67 ErrorLog /var/log/apache2/shaarli-error.log
68 CustomLog /var/log/apache2/shaarli-access.log combined
72 ### Paranoid - Redirect HTTP (:80) to HTTPS (:443)
73 See [Server-side TLS](https://wiki.mozilla.org/Security/Server_Side_TLS#Apache) (Mozilla).[](.html)
77 ServerName shaarli.my-domain.org
78 DocumentRoot /absolute/path/to/shaarli/
81 SSLCertificateFile /absolute/path/to/the/website/certificate.pem
82 SSLCertificateKeyFile /absolute/path/to/the/website/key.key
84 <Directory /absolute/path/to/shaarli/>
86 Options Indexes FollowSymLinks MultiViews
92 ErrorLog /var/log/apache2/shaarli-error.log
93 CustomLog /var/log/apache2/shaarli-access.log combined
96 ServerName shaarli.my-domain.org
97 Redirect 301 / https://shaarli.my-domain.org
100 ErrorLog /var/log/apache2/shaarli-error.log
101 CustomLog /var/log/apache2/shaarli-access.log combined
107 Shaarli use `.htaccess` Apache files to deny access to files that shouldn't be directly accessed (datastore, config, etc.). You need the directive `AllowOverride All` in your virtual host configuration for them to work.
109 **Warning**: If you use Apache 2.2 or lower, you need [mod_version](https://httpd.apache.org/docs/current/mod/mod_version.html) to be installed and enabled.[](.html)
115 Nginx does not natively interpret PHP scripts; to this effect, we will run a [FastCGI](https://en.wikipedia.org/wiki/FastCGI) service, to which Nginx's FastCGI module will proxy all requests to PHP resources.[](.html)
118 - [nginx](http://nginx.org)[](.html)
119 - [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager[](.html)
121 Official documentation:
122 - [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html)[](.html)
123 - [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html)[](.html)
124 - [Pitfalls](http://wiki.nginx.org/Pitfalls)[](.html)
127 - [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla)[](.html)
128 - [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing)[](.html)
131 Once Nginx and PHP-FPM are installed, we need to ensure:
132 - Nginx and PHP-FPM are running using the _same user and group_
133 - both these user and group have
134 - `read` permissions for Shaarli resources
135 - `execute` permissions for Shaarli directories _AND_ their parent directories
137 On a production server:
138 - `user:group` will likely be `http:http`, `www:www` or `www-data:www-data`
139 - files will be located under `/var/www`, `/var/http` or `/usr/share/nginx`
141 On a development server:
142 - files may be located in a user's home directory
143 - in this case, make sure both Nginx and PHP-FPM are running as the local user/group!
145 For all following configuration examples, this user/group pair will be used:
146 - `user:group = john:users`,
148 which corresponds to the following service configuration:
151 ; /etc/php/php-fpm.conf
161 # /etc/nginx/nginx.conf
169 ### (Optional) Increase the maximum file upload size
170 Some bookmark dumps generated by web browsers can be _huge_ due to the presence of Base64-encoded images and favicons, as well as extra verbosity when nesting links in (sub-)folders.
172 To increase upload size, you will need to modify both nginx and PHP configuration:
175 # /etc/nginx/nginx.conf
180 client_max_body_size 10m;
187 # /etc/php5/fpm/php.ini
192 upload_max_filesize = 10M
196 _WARNING: Use for development only!_
202 worker_connections 1024;
207 default_type application/octet-stream;
208 keepalive_timeout 20;
210 index index.html index.php;
214 server_name localhost;
217 access_log /var/log/nginx/access.log;
218 error_log /var/log/nginx/error.log;
221 access_log /var/log/nginx/shaarli.access.log;
222 error_log /var/log/nginx/shaarli.error.log;
225 location ~ (index)\.php$ {
226 fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
227 fastcgi_index index.php;
228 include fastcgi.conf;
235 The previous setup is sufficient for development purposes, but has several major caveats:
236 - every content that does not match the PHP rule will be sent to client browsers:
237 - dotfiles - in our case, `.htaccess`
238 - temporary files, e.g. Vim or Emacs files: `index.php~`
239 - asset / static resource caching is not optimized
240 - if serving several PHP sites, there will be a lot of duplication: `location /shaarli/`, `location /mysite/`, etc.
242 To solve this, we will split Nginx configuration in several parts, that will be included when needed:
245 # /etc/nginx/deny.conf
247 # deny access to dotfiles
254 # deny access to temp editor files, e.g. "script.php~"
262 # /etc/nginx/php.conf
263 location ~ (index)\.php$ {
264 # filter and proxy PHP requests to PHP-FPM
265 fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
266 fastcgi_index index.php;
267 include fastcgi.conf;
271 # deny access to all other PHP scripts
277 # /etc/nginx/static_assets.conf
278 location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
280 add_header Pragma public;
281 add_header Cache-Control "public, must-revalidate, proxy-revalidate";
286 # /etc/nginx/nginx.conf
293 access_log /var/log/nginx/access.log;
294 error_log /var/log/nginx/error.log;
297 # virtual host for a first domain
299 server_name my.first.domain.org;
302 access_log /var/log/nginx/shaarli.access.log;
303 error_log /var/log/nginx/shaarli.error.log;
306 location = /shaarli/favicon.ico {
307 # serve the Shaarli favicon from its custom location
308 alias /var/www/shaarli/images/favicon.ico;
312 include static_assets.conf;
317 # virtual host for a second domain
319 server_name second.domain.com;
322 access_log /var/log/nginx/minigal.access.log;
323 error_log /var/log/nginx/minigal.error.log;
327 include static_assets.conf;
333 ### Redirect HTTP to HTTPS
334 Assuming you have generated a (self-signed) key and certificate, and they are located under `/home/john/ssl/localhost.{key,crt}`, it is pretty straightforward to set an HTTP (:80) to HTTPS (:443) redirection to force SSL/TLS usage.
337 # /etc/nginx/nginx.conf
343 index index.html index.php;
346 access_log /var/log/nginx/access.log;
347 error_log /var/log/nginx/error.log;
351 server_name localhost;
353 return 301 https://localhost$request_uri;
358 server_name localhost;
360 ssl_certificate /home/john/ssl/localhost.crt;
361 ssl_certificate_key /home/john/ssl/localhost.key;
364 access_log /var/log/nginx/shaarli.access.log;
365 error_log /var/log/nginx/shaarli.error.log;
368 location = /shaarli/favicon.ico {
369 # serve the Shaarli favicon from its custom location
370 alias /var/www/shaarli/images/favicon.ico;
374 include static_assets.conf;