Shaarli

From 5409ade28c5f0acf99dbadd4d95e6f8efda5d395 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Thu, 14 Apr 2016 14:20:23 +0200 Subject: Update docs from Wiki --- doc/Server-configuration.html | 100 ++++++++++++++++++++++++++++++------------ 1 file changed, 71 insertions(+), 29 deletions(-) (limited to 'doc/Server-configuration.html') diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html index 3aa89722..e1edf557 100644 --- a/doc/Server-configuration.html +++ b/doc/Server-configuration.html @@ -4,31 +4,49 @@ - Shaarli - Server configuration + Shaarli – Server configuration - +

@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }

Download

Server requirements

Server configuration

Server security

Shaarli installation

Shaarli configuration

Plugin installation & configuration

Docker

Plugin list

Usage

How To

@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }

@@ -79,10 +106,10 @@ code > span.er { color: #ff0000; font-weight: bold; }

Example virtual host configurations for popular web servers

Apache
LightHttpd (empty)
Nginx

Prerequisites

Shaarli is installed in a directory readable/writeable by the user
the correct read/write permissions have been granted to the web server user and/or group
a key pair (public, private) and a certificate have been generated
the appropriate server SSL extension is installed and active

HTTPS, TLS and self-signed certificates

Related guides:

How to Create Self-Signed SSL Certificates with OpenSSL
How do I create my own Certificate Authority?
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

Proxies

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:

X-Forwarded-Proto;
X-Forwarded-Host;
X-Forwarded-For.

Apache

Minimal

<VirtualHost *:80>
+<VirtualHost *:80>
     ServerName   shaarli.my-domain.org
     DocumentRoot /absolute/path/to/shaarli/
-</VirtualHost>
+</VirtualHost>

Debug - Log all the things!

This configuration will log both Apache and PHP errors, which may prove useful to identify server configuration errors.

See:

<VirtualHost *:80>
+<VirtualHost *:80>
     ServerName   shaarli.my-domain.org
     DocumentRoot /absolute/path/to/shaarli/
 
@@ -120,24 +157,24 @@ code > span.er { color: #ff0000; font-weight: bold; }
     php_flag  display_errors on
     php_value error_reporting 2147483647
     php_value error_log /var/log/apache2/shaarli-php-error.log
-</VirtualHost>
+</VirtualHost>

Standard - Keep access and error logs

<VirtualHost *:80>
+<VirtualHost *:80>
     ServerName   shaarli.my-domain.org
     DocumentRoot /absolute/path/to/shaarli/
 
     LogLevel  warn
     ErrorLog  /var/log/apache2/shaarli-error.log
     CustomLog /var/log/apache2/shaarli-access.log combined
-</VirtualHost>
+</VirtualHost>

Paranoid - Redirect HTTP (:80) to HTTPS (:443)

See Server-side TLS (Mozilla).

<VirtualHost *:443>
+<VirtualHost *:443>
     ServerName   shaarli.my-domain.org
     DocumentRoot /absolute/path/to/shaarli/
 
     SSLEngine             on
-    SSLCertificateFile    /absolute/path/to/the/website/certificate.crt
+    SSLCertificateFile    /absolute/path/to/the/website/certificate.pem
     SSLCertificateKeyFile /absolute/path/to/the/website/key.key
 
     <Directory /absolute/path/to/shaarli/>
@@ -158,7 +195,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
     LogLevel  warn
     ErrorLog  /var/log/apache2/shaarli-error.log
     CustomLog /var/log/apache2/shaarli-access.log combined
-</VirtualHost>
+</VirtualHost>

LightHttpd

Nginx

Foreword

@@ -204,13 +241,13 @@ code > span.er { color: #ff0000; font-weight: bold; }

user:group = john:users,

which corresponds to the following service configuration:

; /etc/php/php-fpm.conf
+; /etc/php/php-fpm.conf
 user = john
 group = users
 
 [...][](.html)
 listen.owner = john
-listen.group = users
+listen.group = users

# /etc/nginx/nginx.conf
 user john users;
 
@@ -374,5 +411,10 @@ http {
         include php.conf;
     }
 }

Restricting search engines and web crawler traffic

Creating a robots.txt witht he following contents at the root of your Shaarli installation will prevent "honest" 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.

User-agent: *
+Disallow: /

See: http://www.robotstxt.org/, http://www.robotstxt.org/robotstxt.html, http://www.robotstxt.org/meta.html

-- cgit v1.2.3 From 08dcd8ea58c07cd8258567ca14260aa18ba2660f Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 14 May 2016 11:37:28 +0200 Subject: Doc update Signed-off-by: ArthurHoaro --- doc/Server-configuration.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'doc/Server-configuration.html') diff --git a/doc/Server-configuration.html b/doc/Server-configuration.html index e1edf557..1d2276df 100644 --- a/doc/Server-configuration.html +++ b/doc/Server-configuration.html @@ -60,10 +60,9 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf