Teil 2: Installation eines CalDAV-Servers unter Ubuntu

Nach der Einführung zu sabre/dav im ersten Teil dieser Artikelserie, soll in diesem zweiten Teil die Installation eines eigenen sabre/dav-Server unter Ubuntu Server 16.04 beschrieben werden. Neben sabre/dav selbst benötigt man dafür zusätzlich einen Webserver mit PHP-Support sowie eine MySQL-Datenbank.

Am Ende des Artikels werden alle Bestandteile installiert sein und Sie mit einem eigenen Server zur Synchronisation von Terminen, Kontakten und Aufgaben zwischen Ihren Geräten belohnt.

Installation von Webserver, PHP und MySQL-Datenbank

Installation von nginx mit PHP Support

Die folgenden Schritte wurden unter Ubuntu Server 16.04 getestet und beschreiben die Installation des Webservers Nginx, der benötigten Programmiersprache PHP sowie der MySQL-Datenbank. Sämtliche Befehle werden mit sudo-Rechen ausgeführt. Die Befehle sollten ohne Schwierigkeiten auf andere Linux-Varianten übertragbar sein, jedoch ist es möglich, dass der ein oder andere Befehl eventuell angepasst werden muss. Um diese Fehlerquelle auszuschließen, probieren Sie doch Ihre erste Installation in einer virtuellen Maschine mit Ubuntu Server 16.04.

apt-get update
apt-get upgrade
apt-get install nginx php-fpm php-xml php-mbstring

Nach der Installation wird Nginx automatisch gestartet. Um sicher zu gehen, dass der Webserver auch tatsächlich läuft, kann man den Status des Dienstes mit systemd überprüfen.

systemctl status nginx

# liefert den Output:
nginx.service - A high performance web server and a reverse proxy server
Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
Active: active (running) since Mon 2017-05-18 16:14:00 EDT; 4min 2s ago
Main PID: 6857 (nginx)
  CGroup: /system.slice/nginx.service
      ├─6857 nginx: master process /usr/sbin/nginx -g daemon on; master_process on
      └─6858 nginx: worker process

Wenn man nun einen beliebigen Browser öffnet und in der Adresszeile die IP-Adresse des Servers eingibt, sollte man von nginx begrüßt werden. Die eigene IP ermittelt man am einfachsten mit dem Kommandozeilenbefehl ifconfig.

Ich greife nun vorweg, dass wir sabre/dav später im Verzeichnis /var/www/sabredav installieren werden, und passe direkt die Konfigurationsdateien von nginx an.

# zuerst leere ich die Datei
echo "" > /etc/nginx/sites-available/default

# nun bearbeiten wir die Konfiguration
nano /etc/nginx/sites-available/default

# tragen Sie den folgenden Inhalt ein. 
server {
    listen 80 default_server;
    server_name _;
    root /var/www/sabredav/;
    index server.php;
    rewrite (.*) /server.php$uri break;

    location ~ ^(.+\.php)(.*)$ {
        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $request_filename;
        fastcgi_index server.php;
        include fastcgi_params;
        }
}

# speichern Sie die Datei und verlassen Sie den Editor
# nun prüfen wie die Konfigurationsdatei und starten nginx neu
nginx -t

# folgendes Ergebnis sollte angezeigt werden
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

# Laden Sie die Konfiguration in nginx
nginx -s reload

Manche Leute mögen sich nun fragen, warum wir gerade server.php und nicht index.php verwenden? Ich orientiere mich hierbei an einer Empfehlung des Entwicklers Evert Pot, der ganz klar davon abrät die Datei index.php zu nennen.

Anlage einer MySQL-Datenbank und eines eigenen Users

Obwohl sabre/dav-Server auch ohne eigene Datenbank Dateien verwalten kann, macht der Einsatz von MySQL als Speicherbackend und für die Benutzerauthentifizierung sehr viel Sinn. Mit den folgenden Befehlen wird eine MySQL-Datenbank angelegt und ein passender User angelegt

apt-get install mysql-server mysql-client php-mysql
# während der Installation wählt man ein Root-Passwort für die MySQL-Datenbank
# Hinweis: das ist nicht das root-Passwort von Ubuntu sondern das Root-Passwort der Datenbank

mysql -u root -p -e "CREATE DATABASE sabredav"
mysql -u root -p -e "CREATE USER 'sabredav'@'localhost' IDENTIFIED BY 'MYSQL-PW-DES-USERS-SABREDAV';"
mysql -u root -p -e "GRANT ALL PRIVILEGES ON sabredav . * TO 'sabredav'@'localhost';" 
mysql -u root -p -e "FLUSH PRIVILEGES;"
# Nach Eingabe der Befehle werden Sie aufgefordert ein Passwort einzugeben. Hier müssen Sie das MYSQL-Root-Passwort eingeben.

# Als letzte testen wir die Datenbankverbindung mit dem eben angelegten MySQL-User sabredav
mysql -u sabredav -p"PASSWORT-DES-USERS-SABREDAV-OHNE-LEERZEICHEN"
# Wichtig: zwischen dem Parameter -p und Ihrem Passwort darf kein Leerzeichen eingegeben werden.
# Wenn der Login erfolgreich war, verändert sich die Kommandozeile von root@... zu mysql>

# mit quit verlassen Sie wieder die MySQL-Konsole.
mysql> quit;

Alle notwendigen Voraussetzungen sind damit erfüllt. Für einen ersten Testserver ist dies vollkommen ausreichend. Für eine produktive Maschine sollte man natürlich noch den Webserver per SSL-Zertifikat absichern, die Firewall ufw konfigurieren, den Brute-Force-Schutz fail2ban installieren und die MySQL-Datenbank per mysql_secure_installation absichern. Dieses Thema wird jedoch in einem anderen Artikel beleuchtet werden.

Installation von sabre/dav 3.2 unter Ubuntu 16.04

Die nun folgende Anleitung basiert und übernimmt viele Stellen der Anleitung von Evert Pot von der Webseite sabre.io/dav. Gleichzeitig werde ich an vielen Stellen umfangreiche Ergänzungen oder Erklärungen liefern, um auch Einsteigern einen leichteren Einstieg zu ermöglichen. Denn wie bereits in Teil 1 geschrieben: sabre/dav ist ein Framework von einem Entwickler für andere Entwickler. Diese Anleitung hat einen anderen Anspruch und soll auch anderen Gruppen den Einsteig erleichtern.

curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer
mkdir /var/www/sabredav
cd /var/www/sabredav
composer require sabre/dav ~3.2.0
mkdir /var/www/sabredav/{data,public}
chmod a+rwx data public

Mit diesen wenigen Zeilen Code wird sabre/dav per PHP-Paketmanager "composer" installiert und im Verzeichnis /var/www/sabredav angelegt. Neben der Installation per composer gibt es noch die Möglichkeit sabre/dav direkt von Github zu beziehen, was jedoch keine Abhängigkeiten prüft und auch eine spätere Aktualisierung von sabre/dav etwas schwerer macht.

Konfiguration von sabre/dav in der server.php

Mit der Installation des Frameworks liegen nun alle notwendigen Dateien auf der Festplatte des Servers. Um nun einen einfachen WebDAV basierten Dateiserver aufzusetzen, legt man eine server.php im Hauptverzeichnis (d.h. /var/www/sabredav/server.php) an und kopiert folgende Inhalte in die Datei. Wenn Sie die gleiche Datei und Ordnerstruktur verwenden, werden Sie nur das MySQL-Root-Passwort ändern müssen. Bei anderen Ordnerstrukturen, muss ggf. die Variable $baseUri angepasst werden, damit sabre/dav richtig geladen werden kann.

<?php
date_default_timezone_set('Europe/Berlin');
$baseUri = '/';
$pdo = new \PDO('mysql:dbname=sabredav;host=127.0.0.1', 'sabredav', 'MYSQL-PW-DES-USERS-SABREDAV');
$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);

require_once 'vendor/autoload.php';

$authBackend      = new \Sabre\DAV\Auth\Backend\PDO($pdo);
$principalBackend = new \Sabre\DAVACL\PrincipalBackend\PDO($pdo);
$carddavBackend   = new \Sabre\CardDAV\Backend\PDO($pdo);
$caldavBackend    = new \Sabre\CalDAV\Backend\PDO($pdo);

$nodes = [
    new \Sabre\CalDAV\Principal\Collection($principalBackend),
    new \Sabre\CalDAV\CalendarRoot($principalBackend, $caldavBackend),
    new \Sabre\CardDAV\AddressBookRoot($principalBackend, $carddavBackend),
];

$server = new \Sabre\DAV\Server($nodes);
if (isset($baseUri)) $server->setBaseUri($baseUri);

$server->addPlugin(new \Sabre\DAV\Auth\Plugin($authBackend));
$server->addPlugin(new \Sabre\DAV\Browser\Plugin()); 
$server->addPlugin(new \Sabre\CalDAV\Plugin());
$server->addPlugin(new \Sabre\CardDAV\Plugin());
$server->addPlugin(new \Sabre\DAV\Sync\Plugin());

$server->exec();

Speichern Sie die Datei. Als nächstes werden wir die nötigen MySQL-Datenbankstrukturen laden, damit sabre/dav direkt lauffähig ist. Geben Sie hierfür die folgenden Befehle in der Konsole ein

cd /var/www/sabredav/vendor/sabre/dav/examples/sql
cat mysql.* | mysql -u sabredav -p -D sabredav -h 127.0.0.1

# die nun erzeugte Datenbankstruktur kann man sich natürlich auch ansehen
mysql -u sabredav -p
mysql> use sabredav;
mysql> show tables;
+-----------------------+
| Tables_in_sabredav    |
+-----------------------+
| addressbookchanges    |
| addressbooks          |
| calendarchanges       |
| calendarinstances     |
| calendarobjects       |
| calendars             |
| calendarsubscriptions |
| cards                 |
| groupmembers          |
| locks                 |
| principals            |
| propertystorage       |
| schedulingobjects     |
| users                 |
+-----------------------+
14 rows in set (0.00 sec)

mysql> select * from users;
mysql> quit;

Erster Aufruf von sabre/dav per Browser

Nun kommt der Moment der Wahrheit. Wenn Sie erneut die IP-Adresse des Servers in einem beliebigen Browser aufrufen, sollten Sie zur Eingabe von Benutzername und Passwort aufgefordert werden. Geben Sie hier zweimal admin ein um zur Weboberfläche von sabre/dav zu gelanden.

Was tun bei Fehlern?

Sollten Sie nicht den Login von sabre/dav sehen oder der Login scheitern, sollten Sie zuerst die folgenden Punkte überprüfen. Diese stellen unserer Erfahrung nach die häufigsten Fehlerquellen dar:

  • Prüfen Sie per systemctl, ob Nginx und der MySQL-Server laufen.
  • Prüfen Sie die Einstellungen in der /var/www/sabredav/server.php. Häufige Fehler sind ein falsche MySQL-Passwort des Users sabredav, eine falsche BaseUri oder fehlende Berechtigungen für den User www-data: auf den Ordner /var/www/sabredav.
  • Prüfen Sie mit tail die Log-Dateien von Nginx unter /var/log/nginx
  • Prüfen Sie, ob Ihr erster User in der MySQL-Datenbank wirklich gespeichert wurde. Verbinden Sie sich hierfür mit mysql -u sabredav -p mit der Datenbank und lassen Sie sich den User anzeigen. Bedenken Sie, dass das Passwort in der MySQL-Datenbank nicht im Klartext eingetragen wird.
  • Prüfen Sie, ob der User www-data Zugriff auf die Dateien unter /var/www/sabredav hat.

Ergebnis: ein eigener CalDAV/CardDAV-Server

Sie können stolz auf sich sein. Sie haben es geschafft einen eigenen Synchronisationsserver für Termine, Aufgaben und Kontakte auf Ihrem Server zu installieren. Ab sofort kümmert sich sabre/dav um die Synchronisation Ihrer privaten Daten.

Zwar müssen Sie sich noch selbst um die Verwaltung der User und deren Berechtigungen kümmern, doch wie das geht, werden Sie im nächsten Teil erfahren. Aber eines kann ich Ihnen versichern. Ihre Reise mit sabre/dav hat gerade erst begonnen und die vielleicht größte Hürde haben Sie bereits genommen.


Nachtrag: sabre/dav in einem Unternverzeichnis

Von einem Leser kam die Nachfrage, ob man sabre/dav auch in einem Unterverzeichnis betreiben kann. Dies ist möglich, wobei es von den Entwicklern nicht empfohlen wird. Diese schreiben It's wise to make sure that a Cal/CardDAV server runs on the root of a server. Wir können bestätigen, dass es besser ist sabre/dav im Root-Verzeichnis zu betreiben, weil dann die Konfiguration der Clients teilweise deutlich einfacher ist. Gleichzeitig konnten wir jedoch neben einem größeren Aufwand keine Funktionseinschränkungen feststellen.

Mit der folgenden nginx-Konfiguration ist es möglich auch sabre/dav in einem Unterverzeichnis zu betreiben:

location /dav {
        #root /var/www;
        root /var/www/;
        index server.php;

        rewrite ^ /dav/server.php$uri;
}

location ~ ^/dav/(.+\.php)(.*)$ {
        root /var/www;
        index server.php;

        fastcgi_split_path_info ^(.+\.php)(/.+)$;
        fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $request_filename;
        fastcgi_index server.php;
        include fastcgi_params;
}

Die oben aufgeführte Konfiguration geht davon aus, dass sabre/dav im Verzeichnis /var/www/dav liegt und der Aufruf per Browser über das Verzeichnis /dav erfolgt. Neben der nginx-Konfiguration muss man zusätzlich noch die baseUri in der server.php anpassen.

$baseUri = '/dav';

Danach ist sabre/dav auch über das Unterverzeichnis /dav erreichbar.

geschrieben von

Christoph Dyllick-Brenzinger

Christoph ist Gründer und Chefentwickler von datamate.

2 Kommentare zu Teil 2: Installation eines CalDAV-Servers unter Ubuntu

  1. Stefan27. Juli 2017, 9:42

    Danke für diese super Anleitung. Ist es auch möglich sabredav über ein Unterverzeichnis in nginx anzubieten?

    • Christoph Dyllick-Brenzinger4. August 2017, 13:39

      Hallo Stefan,
      vielen Dank für deine Frage. Ja, man kann sabre/dav auch in einem Unterverzeichnis betreiben.
      Ich habe den Artikel entsprechend erweitert.
      Viele Grüße
      Christoph

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.