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)
111 Apache module `mod_rewrite` **must** be enabled to use the REST API. URL rewriting rules for the Slim microframework are stated in the root `.htaccess` file.
117 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)
120 - [nginx](http://nginx.org)[](.html)
121 - [php-fpm](http://php-fpm.org) - PHP FastCGI Process Manager[](.html)
123 Official documentation:
124 - [Beginner's guide](http://nginx.org/en/docs/beginners_guide.html)[](.html)
125 - [ngx_http_fastcgi_module](http://nginx.org/en/docs/http/ngx_http_fastcgi_module.html)[](.html)
126 - [Pitfalls](http://wiki.nginx.org/Pitfalls)[](.html)
129 - [Server-side TLS (Nginx)](https://wiki.mozilla.org/Security/Server_Side_TLS#Nginx) (Mozilla)[](.html)
130 - [PHP configuration examples](http://kbeezie.com/nginx-configuration-examples/) (Karl Blessing)[](.html)
133 Once Nginx and PHP-FPM are installed, we need to ensure:
134 - Nginx and PHP-FPM are running using the _same user and group_
135 - both these user and group have
136 - `read` permissions for Shaarli resources
137 - `execute` permissions for Shaarli directories _AND_ their parent directories
139 On a production server:
140 - `user:group` will likely be `http:http`, `www:www` or `www-data:www-data`
141 - files will be located under `/var/www`, `/var/http` or `/usr/share/nginx`
143 On a development server:
144 - files may be located in a user's home directory
145 - in this case, make sure both Nginx and PHP-FPM are running as the local user/group!
147 For all following configuration examples, this user/group pair will be used:
148 - `user:group = john:users`,
150 which corresponds to the following service configuration:
153 ; /etc/php/php-fpm.conf
163 # /etc/nginx/nginx.conf
171 ### (Optional) Increase the maximum file upload size
172 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.
174 To increase upload size, you will need to modify both nginx and PHP configuration:
177 # /etc/nginx/nginx.conf
182 client_max_body_size 10m;
189 # /etc/php5/fpm/php.ini
194 upload_max_filesize = 10M
198 _WARNING: Use for development only!_
204 worker_connections 1024;
209 default_type application/octet-stream;
210 keepalive_timeout 20;
212 index index.html index.php;
216 server_name localhost;
219 access_log /var/log/nginx/access.log;
220 error_log /var/log/nginx/error.log;
223 try_files $uri /shaarli/index.php$is_args$args;
224 access_log /var/log/nginx/shaarli.access.log;
225 error_log /var/log/nginx/shaarli.error.log;
228 location ~ (index)\.php$ {
230 fastcgi_split_path_info ^(.+\.php)(/.+)$;
231 fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
232 fastcgi_index index.php;
233 include fastcgi.conf;
240 The previous setup is sufficient for development purposes, but has several major caveats:
241 - every content that does not match the PHP rule will be sent to client browsers:
242 - dotfiles - in our case, `.htaccess`
243 - temporary files, e.g. Vim or Emacs files: `index.php~`
244 - asset / static resource caching is not optimized
245 - if serving several PHP sites, there will be a lot of duplication: `location /shaarli/`, `location /mysite/`, etc.
247 To solve this, we will split Nginx configuration in several parts, that will be included when needed:
250 # /etc/nginx/deny.conf
252 # deny access to dotfiles
259 # deny access to temp editor files, e.g. "script.php~"
267 # /etc/nginx/php.conf
268 location ~ (index)\.php$ {
269 # Slim - split URL path into (script_filename, path_info)
271 fastcgi_split_path_info ^(.+\.php)(/.+)$;
273 # filter and proxy PHP requests to PHP-FPM
274 fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
275 fastcgi_index index.php;
276 include fastcgi.conf;
280 # deny access to all other PHP scripts
286 # /etc/nginx/static_assets.conf
287 location ~* \.(?:ico|css|js|gif|jpe?g|png)$ {
289 add_header Pragma public;
290 add_header Cache-Control "public, must-revalidate, proxy-revalidate";
295 # /etc/nginx/nginx.conf
302 access_log /var/log/nginx/access.log;
303 error_log /var/log/nginx/error.log;
306 # virtual host for a first domain
308 server_name my.first.domain.org;
311 # Slim - rewrite URLs
312 try_files $uri /shaarli/index.php$is_args$args;
314 access_log /var/log/nginx/shaarli.access.log;
315 error_log /var/log/nginx/shaarli.error.log;
318 location = /shaarli/favicon.ico {
319 # serve the Shaarli favicon from its custom location
320 alias /var/www/shaarli/images/favicon.ico;
324 include static_assets.conf;
329 # virtual host for a second domain
331 server_name second.domain.com;
334 access_log /var/log/nginx/minigal.access.log;
335 error_log /var/log/nginx/minigal.error.log;
339 include static_assets.conf;
345 ### Redirect HTTP to HTTPS
346 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.
349 # /etc/nginx/nginx.conf
355 index index.html index.php;
358 access_log /var/log/nginx/access.log;
359 error_log /var/log/nginx/error.log;
363 server_name localhost;
365 return 301 https://localhost$request_uri;
370 server_name localhost;
372 ssl_certificate /home/john/ssl/localhost.crt;
373 ssl_certificate_key /home/john/ssl/localhost.key;
376 # Slim - rewrite URLs
377 try_files $uri /index.php$is_args$args;
379 access_log /var/log/nginx/shaarli.access.log;
380 error_log /var/log/nginx/shaarli.error.log;
383 location = /shaarli/favicon.ico {
384 # serve the Shaarli favicon from its custom location
385 alias /var/www/shaarli/images/favicon.ico;
389 include static_assets.conf;