Adminhandbuch

Handbuch zur Installation und Administration des Syncwerk Servers

• Installation
• Voraussetzungen
• Installation
• Unbeaufsichtigte Installation
• Konfiguration
• Pfade
• Freischaltschlüssel
• /etc/syncwerk/ccnet.conf
• /etc/syncwerk/gunicorn.conf
• /etc/nginx/conf.d/syncwerk.conf
• /etc/syncwerk/restapi_settings.py
• /etc/syncwerk/server.conf
• /etc/syncwerk/storage.ini
• syncwerk-server-admin (CLI)
• Wartung
• syncwerk-server-admin
• Entwicklung
• Offene API

Installation

Voraussetzungen

Hardwareanforderungen

• Min. 2 CPU Kerne
• Min. 4 GB RAM
• Min. 16 GB Speicherplatz

Betriebssystem

• Debian 9 (AMD64)
• Debian 10 (AMD64)

Installation

Der Syncwerk Server kann auf Debian 9 (Stretch) oder 10 (Buster) (AMD64) installiert werden.

Bis zu drei Benutzer sind kostenfrei. Brauchen Sie mehr als drei Benutzerkonten, können Sie weitere Konten bestellen.

1. Registrieren Sie zuerst ein kostenfreies Downloadkonto. Sie brauchen diese Daten während der Installation unter Punkt 4.
2. Führen Sie eine Debian Minimalinstallation durch. Verzichten Sie bitte auf eine Desktopumgebung auf dem Server.
3. Installation des Syncwerk Servers mit root Rechten:

   apt-get update ;\
   apt-get install ca-certificates wget -y ;\
   bash <(wget -qO- https://repo.syncwerk.com/repo/installers/syncwerk-server-installer-stable.sh)

4. Folgen Sie den Anweisungen des Installers.
5. Das war’s schon. Die Syncwerk Server Komponenten sind fertig installiert.

Die Setuproutine hat Ihnen ein initiales Administratorkonto eingerichtet. Die dynamisch erstellten Zugangsdaten werden am Ende der Installation auf der Konsole angezeigt. Sollten Sie sie verpasst haben, finden Sie diese Daten später in der Datei /etc/syncwerk/admin.txt.

Loggen Sie sich nun in der Web-App mit den initialen Admin-Zugangsdaten ein und beginnen Ihren Syncwerk Server einzurichten. Die Web-App erreichen Sie unter https://{DOMAIN|IP}. Also z.B. unter https://syncwerk.cloud oder https://192.168.1.23.

Unbeaufsichtigte Installation

Verwenden Sie diese Installationsvariante um den Syncwerk Server ohne Benutzerinteraktion zu installieren.

Der Syncwerk Server kann auf Debian 9 (Stretch) oder 10 (Buster) (AMD64) installiert werden.

Bis zu drei Benutzer sind kostenfrei. Brauchen Sie mehr als drei Benutzerkonten, können Sie weitere Konten bestellen.

1. Registrieren Sie zuerst ein kostenfreies Downloadkonto. Sie brauchen diese Daten während der Installation unter Punkt 3.
2. Führen Sie eine Debian Minimalinstallation durch. Verzichten Sie bitte auf eine Desktopumgebung auf dem Server.
3. Installation des Syncwerk Servers mit root Rechten. Tauschen Sie zur Installation user@domain.tld und password mit Ihren Zugangsdaten aus:

   export DEBIAN_FRONTEND=noninteractive ;\
   apt-get update ;\
   apt-get install ca-certificates wget lsb-release -y ;\
   DIST="$(lsb_release -sc)" ;\
   ARCH=$(dpkg --print-architecture) ;\
   wget -qN https://repo.syncwerk.com/repo/installers/syncwerk-server-installer-stable-${DIST}-${ARCH} ;\
   chmod +x syncwerk-server-installer-stable-${DIST}-${ARCH} ;\
   ./syncwerk-server-installer-stable-${DIST}-${ARCH} --agree-to-terms user@domain.tld password

4. Das war’s schon. Die Syncwerk Server Komponenten sind fertig installiert.

Die Setuproutine hat Ihnen ein initiales Administratorkonto eingerichtet. Die dynamisch erstellten Zugangsdaten werden am Ende der Installation auf der Konsole angezeigt. Sollten Sie sie verpasst haben, finden Sie diese Daten später in der Datei /etc/syncwerk/admin.txt.

Loggen Sie sich nun in der Web-App mit den initialen Admin-Zugangsdaten ein und beginnen Ihren Syncwerk Server einzurichten. Die Web-App erreichen Sie unter https://{DOMAIN|IP}. Also z.B. unter https://syncwerk.cloud oder https://192.168.1.23.

Sobald der Schalter --agree-to-terms verwendet wird, wird der ONLYOFFICE Document Server nicht automatisch mitinstalliert. Mit syncwerk-server-admin setup-onlyoffice können Sie ihn jederzeit nachinstallieren und aktivieren. 

---

Infos zum Konsolenbefehl syncwerk-server-admin finden Sie hier:

• https://support.syncwerk.de/books/adminhandbuch/page/syncwerk-server-admin-(CLI)
• https://support.syncwerk.de/books/adminhandbuch/page/syncwerk-server-admin

Konfiguration

Pfade

Der Syncwerk Server wird nach den Richtlinien des Filesystem Hierarchy Standard (FHS) im Linux Betriebssystems installiert. Nachfolgend erfahren Sie, welche Komponenten wo gespeichert sind. 

Konfigurationsverzeichnis

Konfigurationsdateien werden Zentral unter /etc/syncwerk gespeichert. Hier werden bei Bedarf individuelle Konfigurationen durchgeführt. Wir empfehlen dieses Verzeichnis bei der Datensicherung zu berücksichtigen.

/etc/syncwerk/
├── admin.txt
├── authorization.key
├── ccnet.conf
├── config.db
├── akuh9nohCh3boot9iePh3Ningeeneemauga9he3u.peer
├── gunicorn.conf
├── mykey.peer
├── mysql.txt
├── restapi_settings.py
├── server.conf
└── storage.ini

Web App

Die Angular basierte Web App befindet sich im Verzeichnis /usr/share/syncwerk/webapp/. Änderungen in diesem Ordner werden bei Updates gelöscht. Dieses Verzeichnis kann bei der Datensicherung ausgelassen werden.

RESTAPI und WebDAV

Die Django basierte RestaAPI sowie WebDAV Implementierung sind unterhalb von/usr/share/python/syncwerk/restapi/ gespeichert. Änderungen in diesem Ordner werden bei Updates gelöscht. Dieses Verzeichnis kann bei der Datensicherung ausgelassen werden.

/usr/share/python/syncwerk/restapi/

NGINX-Proxy

Unter /etc/nginx/conf.d/syncwerk.conf befindet sich die Webserver Konfiguration. 

Syncwerk Server Komponenten

Unterhalb des Verzeichnis /usr/bin/ befinden sich die ausführbaren Syncwerk Server Dateien.

/usr/bin/
├── syncwerk-server
├── syncwerk-server-ccnet
├── syncwerk-server-daemon
├── syncwerk-server-fsck
├── syncwerk-server-fuse
├── syncwerk-server-gc
├── syncwerk-server-migrate

Das administrative Serverprogramm finden Sie unter /usr/sbin/syncwerk-server-admin. Da das Programm tiefgreidende Änderungen an der Syncwerk Server Installation durchführen kann, darf es nur mit Root-Rechten ausgeführt werden.

Dynamische Bibliotheken

Unter /lib/x86_64-linux-gnu/ finden Sie einige Bibliotheken die zur Kommunikation zwischen den Syncwerk Server Komponenten nötig sind.

/lib/x86_64-linux-gnu/
├── librpcsyncwerk.a
├── librpcsyncwerk.la
├── librpcsyncwerk.so -> librpcsyncwerk.so.1.0.2
├── librpcsyncwerk.so.1 -> librpcsyncwerk.so.1.0.2
├── librpcsyncwerk.so.1.0.2

Sitzungsdaten und Nutzdaten (Object Storage)

Unter /var/lib/syncwerk/ werden neben den Laufzeitdaten auch die eigentlichen Nutzdaten /var/lib/syncwerk/storage/der verwalteten Ordner gespeichert. Bei der Datensicherung sollte mindestens das Verzeichnis /var/lib/syncwerk/storage/gesichert werden.

/var/lib/syncwerk/
├── avatars
├── backup
├── session
├── storage
│   ├── blocks
│   ├── commits
│   └── fs
├── template
├── thumbnails
└── tmp

Logdateien

Unter /var/log/syncwerk/ finden Sie alle Logdateien der Syncwerk Server Dienste. Diese Verzeichnis kann bei der Datensicherung ausgelassen werden.

/var/log/syncwerk/
├── background_email_sending.log
├── ccnet.log
├── daemon.log
├── fsck.log
├── gc.log
├── install.log
├── onlyoffice.log
├── restapi.log
├── server.log
├── virusscan.log
├── webapp.log
└── webdav.log

 

Freischaltschlüssel

Um mehr als drei Nutzer mit dem Syncwerk Server betreiben zu können, benötigen Sie eine kostenpflichtige Lizenz (https://www.syncwerk.de/produkte/selbst-gehostet/) bzw. einen Testschlüssel. Um einen Testschlüssel zu erhalten, wenden Sie sich bitte an support@syncwerk.com.

Sobald Sie Ihren Freischaltschlüssel erhalten habe, spielen Sie ihn über den Adminbereich in der Web App ein. Sollte Ihre Lizenz bereits abgelaufen sein, können Sie den Schlüssel auch direkt unter /etc/syncwerk/authorization.key speichern.

/etc/syncwerk/ccnet.conf

In dieser Datei wird die Konfiguration der Benutzerverwaltung durchgeführt. Achten Sie darauf, dass die Variable SERVICE_URL auf die öffentliche Adresse Ihres Servers auflöst.

/etc/syncwerk/gunicorn.conf

In dieser Datei wird das Web Server Gateway Interface (WSGI) konfiguriert.

/etc/nginx/conf.d/syncwerk.conf

Hier finden Sie die Webserverkonfiguration. Externe Zugriffe laufen über den NGINX Webserver und werden an die internen Syncwerk Server Dienste weitergeleitet.

Während der automatisierten Installation erstellen wir eine HTTPS basierte Konfiguration, die nur verschlüsselten Zugriff ermöglicht. Externe Zugriffe auf die Syncwerk Dienste führen daher ausschließlich über gesicherte HTTPS-Verbindungen statt.

Aus Sicherheitsgründen stellen wir keine Inforamtionen zum unverschlüsselten Zugriffe auf den Server bereit.

Bei eigenen Anpassungen, achten Sie bitte immer auf eine sichere Konfiguration. Um Browserwarnungen zu vermeiden, empfiehlt es sich,  ein offizielles Zertifikat zu installieren. Mit dem Befehl syncwerk-server-admin setup-letsencrypt-certificate können Sie ganz bequem ein kostenloses offizielles Zertifikat beantragen und automatisch installieren.

 

/etc/syncwerk/restapi_settings.py

In dieser Datei werden grundlegende Konfigurationen der Django basierten RestAPI durchgeführt. Sehen Sie sich die Datei an und ändern ggf. gewünschte Werte. Im Zweifel sollten Sie vorher eine Kopie erstellen um diese bei Fehlern schnell wiederherstellen zu können.

/etc/syncwerk/server.conf

In dieser Datei wird die Konfiguration des Dateiservers durchgeführt. Eventuell möchten Sie hier die Standardquota für Benutzerkonten oder auch die Speicherdauer der Schattenkopien ändern.

/etc/syncwerk/storage.ini

In dieser Datei wird der Pfad zum Object Storage festgelegt. Standardmäßig zeigt dieser auf /var/lib/syncwerk/.

Bei falscher Konfiguration können Desktop und Mobile Apps nicht mehr synchronisieren. Ändern Sie den Pfad daher im Zweifel nur nach Rücksprache mit unserem Support.

syncwerk-server-admin (CLI)

Mit dem Konsolenbefehl syncwerk-server-admin können Sie weitere Funktionen nachinstallieren und/oder auf einfache Weise administrative Tätigkeiten durchführen.

root@syncwerk:~# syncwerk-server-admin 

Name:
  syncwerk-server-admin - A Syncwerk server setup and administration tool

Usage:
  syncwerk-server-admin [OPTIONS] [ARGS]

Commands:
  support                         Show how to receive official support
  setup                           Automatically setup production ready Syncwerk server
  update-translations             Update translations (May take very long)
  update-static-files             Update static files (collectstatic)
  start                           Start all Syncwerk server services
  stop                            Stop all Syncwerk server services
  restart                         Restart all Syncwerk server services
  fix-permissions                 Fix file permissions and ownership of Syncwerk server components
  report                          Create report for support requests
  fsck                            Check Syncwerk block storage data
  mount [MOUNTPOINT]              Mount unencrypted folders locally in read only mode
  umount                          Unmount locally mounted folders
  gc                              Run garabage collection to delete admin trash and expired file versions
  change-email-address            Change user accounts email address 
  backup-databases                Backup Syncwerk server databases and save to /var/lib/syncwerk/backup/
  backup-object-storage           Backup Syncwerk server object storage and save to /var/lib/syncwerk/backup/
  backup-configurations           Backup Syncwerk server configurations and save to /var/lib/syncwerk/backup/
  backup-server-applications      Backup installed Syncwerk server application and save to /var/lib/syncwerk/backup/
  backup-all                      Backup Syncwerk server configuration, databases, object-storage and save to /var/lib/syncwerk/backup/
  setup-onlyoffice                Install ONLYOFFICE for file preview and editing
  setup-clamav-virus-scanner      Install and setup ClamAV virus scanner 
  run-virus-scanner               Runs virus scanner manually
  setup-letsencrypt-certificate   Install Let\'s Encrypt certificate for the domain name: test.syncwerk.de
                                  Make sure the configured domain name publicly resolves to this server before running.
  setup-samba-ad-dc               Install Samba based Active Directory for "DC=syncwerk,DC=de"
  create-file-list                Create a list of all files in unencrypted folders


SUPPORT:
  For support contact us at support@syncwerk.com or visit https://www.syncwerk.com

Wartung

syncwerk-server-admin

Nachfolgend finden Sie einige nützliche Befehle zur Systemadministration und Wartung:

• syncwerk-server-admin gc - Entfernt gelöschte Inhalte unwiderruflich aus dem Object Storage
• syncwerk-server-admin fsck - Prüft die logische Konsistenz der Ordner im Object Storage
• syncwerk-server-admin support - Zeigt Supportoptionen an
• syncwerk-server-admin setup-clamav-virus-scanner - Installiert und aktiviert den ClamAV Virenscanner
• syncwerk-server-admin run-virus-scanner - Führt den Virenscanner ad-hoc aus. 
• syncwerk-server-admin setup-letsencrypt-certificate - Beantragt und installiert ein kostenfreies Let's Encrypt Zertifikat

Entwicklung

Offene API

Unter https://syncwerk.cloud/api3/redoc/ finden Sie die Dokumentation der Syncwerk RestAPI.