Administrator Handbuch

Dokuplan ist eine Software zum digitalen Dokumentieren von Industrieanlagen, hergestellt von der Firma Rohrleitungsbau Appen. Sie können die Dokuplan-Services in der Cloud oder On-Premises betreiben. Für iOS und Android gibt es eine Dokuplan-App, die nach dem Prinzip offline first arbeitet.

Erste Schritte

Lizensierung

Für den Betrieb des Dokuplan Servers benötigen Sie eine Lizenz. Diese wird Ihnen in Form einer CSV-Datei geliefert und diese Datei importieren Sie per Web-Interface beim ersten Kontakt mit dem Server.

Bevor die Aufnahme der Anlagen-Bauteile starten kann, müssen die Barcodes für diese Bauteile importiert werden. Sie werden ebenfalls in einer CSV-Datei von RBA geliefert.

Registrierung

Jeder Benutzer von Dokuplan muss sich registrieren. Die Registrierung geschieht grundsätzlich über das Web-Interface von Dokuplan. Man kann also nicht mit der Dokuplan-App loslegen, ohne sich über das Web-Interface registriert zu haben. Der erste registrierte Benutzer wird als Administrator angesehen. Nach der Registrierung ist der Administrator automatisch bei Dokuplan angemeldet. Nur ein Administrator darf weitere Benutzer zulassen und deren Zugriffsberechtigungen bestimmen.

Ein neuer Benutzer bekommt nach der Registrierung eine Mail, mit der er die Registrierung bestätigen kann. Ausserdem erhält der Administrator eine Mail, die ihn auffordert, den neuen Benutzer zuzulassen und seine Rechte einzutragen. Ist dies getan, so kann die Arbeit beginnen.

Bevor die Aufnahme von Bauteilen starten kann, müssen Lizenzen importiert werden.

Installation mit DEBIAN

Dokuplan kommt in einem DEBIAN-Paket zur Installation auf einem Computer mit dem Betriebssystem Ubuntu 22.04 LTS.

Voraussetzungen

Auf dem Dokuplan-Server muss Ubuntu 22.04 LTS installiert sein.
Administration über Kommandozeile bzw. SSH.
Dokuplan Serverlizenz

Installationsschritte

Melden Sie sich auf dem Server an.
Prüfen Sie, ob die Zeitzone richtig eingestellt ist. Ändern Sie sie ggf. mit

sudo timedatectl set-timezone Europe/Berlin

Registrieren Sie das Dokuplanning-Repository und installieren Sie Dokuplan mit den Kommandos

sudo wget -qO- http://cloud.dokuplanning.de:9000/repo_key.key | tee /etc/apt/trusted.gpg.d/repo_key.asc
sudo apt update
sudo apt install dokuplan

Die Dokuplan-Konfiguration befindet sich in dem neu entstandenen Verzeichnis /etc/dokuplan. Außerdem generiert Dokuplan Dateien in der Apache-Konfiguration. Prüfen Sie die Verzeichnisse /etc/apache2/sites-enabled und /etc/apache2/conf-enabled.
Wenn Sie die Konfiguration ändern. so müssen Sie den Dokuplan-Service neu starten mit dem Kommando

sudo systemctl restart dokuplan

Mehrere Mandanten

Wenn Sie mehrere Mandanten oder Instanzen nutzen wollen, müssen Sie für jeden Mandanten eine Konfigurationsdatei /etc/dokuplan/appsettings.<mandant>.json anlegen. Diese Datei erstellen Sie als Kopie von /etc/dokuplan/appsettings.Native.json und verändern dann die Parameter

DatabaseV2.Name
Kestrel.http
kestrel.https
ServerName

Bei mehr als einer appsettings.*.json -Datei wird appsettings.Native.json ignoriert.

Appsettings

Liste der Konfigurationsparameter in /etc/dokuplan/appsettings.*.json:

DatabaseV2.Server: Adresse des Datenbank-Servers
DatabaseV2.Name: Name der Datenbank
DatabaseV2.User: Besitzer der Datenbank
DatabaseV2.Password: Passowort des Besitzers
Logging.LogLevel.Default: Verfügbar: {Trace, Debug, Info, Warn, Error, Fatal}
Logging.LogLevel.System: Abweichende Einstellung für System-Meldungen
Logging.LogLevel.Microsoft: Abweichende Einstellung für MS-Bibliotheken
Kestrel.http: Port für HTTP-Verkehr
Kestrel.https: Port für HTTPS-Verkehr
Kestrel.Hosts: Welche Hosts sollen Zugriff erhalten?
Certificates.signing: Zertifikat für HTTPS
ShowPII: Zeige Authentifikationsdaten (true/false)
Data: Verzeichnis für Upload-Daten
Authority: Adresse des Identity-Service
SyncServer: Adresse des Synchronisations-Service
Morelo: Handelt es sich um die Reisemobil-Variante? (true/false)
REALHOST: Die Serveradresse für die Außenkommunikation, z.B. Email

Datensicherung

Die Datensicherung ist integriert. Es werden täglich inkrementelle Backups der Datenbank und der Dokumente durchgeführt. Diese Backups werden von dem Tool duplicity gepackt, verschlüsselt im Verzeichnis /var/backupvolume für den Gast-Account bereitgestellt. Von dort können sie in die unternehmensweite Datensicherung übernommen werden.

Zur Integration in ein Windows-Netzwerk werden die SMB-Shares dpbackup und dpdoc exportiert. Sie zeigen auf die Verzeichnisse /var/backupvolume bzw. /usr/share/doc.

Einstellungen

Passen Sie die Einstellungen in /etc/backupninja.conf an, insbesondere die Parameter reportemail und when.
In /etc/samba/smb.conf werden die SMB-Shares konfiguriert.
In /etc/backup.d wird festgelegt, welche Daten gesichert werden.
Das Dokuplan-Paket konfiguriert den Email-Service postfix. Wenn Sie diesen Service umkonfigurieren wollen, können Sie das Kommando sudo dpkg-reconfigure postfix verwenden.

Wiederherstellung

Für die Wiederherstellung wird das Tool duplicity benutzt. Folgende Kommandos stehen zur Verfügung:

duplicity collection-status file:///var/backupvolume
duplicity list-current-files file:///var/backupvolume
duplicity restore file:///var/backupvolume .

Für die Kommandos, die auf die Verschlüsselung zugreifen, wird ein Passwort benötigt. Dieses Passwort ist in der Datei /etc/backup.d/30-<domain>.dup hinterlegt.

Die Datenbank kann mit dem Tool Adminer restauriert werden. Adminer ist zu erreichen unter der Adresse

http://<adresse_ihres_servers>:9000/adminer

Der Benutzer heißt root und das Passwort ist in der Datei /etc/backup.d/20-<domain>.mysql hinterlegt.

Achtung: Die Adresse und Portnummer können abweichend konfiguriert sein.

Installation mit Docker

Dokuplan kommt in einem Docker-Container. Damit steht die Applikation für die Betriebssysteme Windows, Linux und MacOS zur Verfügung. Mit den Docker-Tools wird der Container von einem öffentlichen Repository geladen und ausgeführt.

Informationen zur Docker-Technologie finden Sie hier.

Voraussetzungen

Auf dem Server muss Docker Engine installiert sein, siehe https://docs.docker.com/engine/

Installation

Laden Sie das Dokuplan-Image mit dem Befehl

docker pull rbappen/dokuplan:latest

Erstellen Sie die Konfiguration des Images in einer docker-compose.yml Datei.
Starten Sie die Applikation mit

docker-compose up -d

Konfiguration

Am besten lässt sich die öffentliche Schnittstelle des Docker-Containers anhand der Konfigurationsdatei docker-compose.yml darstellen:

version: '3.5'

services:
  dokuplan:
    image: rbappen/dokuplan:latest
    ports:
      - "8010:443"      # Dokuplan
      - "9000:9000"     # Adminer
    hostname: dokuplan.domain.com
    entrypoint: dokuplan
    # entrypoint: tail -f /dev/null
    volumes:
      - backup:/var/backupvolume
      - data:/var/lib/dokuplan
      - logs:/var/log
      - db:/var/lib/mysql
      - /etc/apache2/ssl:/etc/apache2/ssl:ro
      - /etc/localtime:/etc/localtime:ro
      # App-Konfiguration, "siehe Abschnitt Appsetings"
      - /srv/docker/etc/appsettings.my.json:/etc/dokuplan/appsettings.Native.json:ro
    environment:
      - TZ=Europe/Berlin
      - CERT=cloud.dokuplanning.de
      - REALHOST=server.domain.com:5100
    logging:
      driver: "json-file"
      options: 
        max-size: "2m"
        max-file: "3"

volumes:
  db:
  data:
  logs:
  backup:

Mehrere Mandanten

Wenn Sie mehrere Mandanten nutzen wollen, müssen Sie je Mandant einen Dokuplan-Docker-Container starten und jeweils die docker-compose.yml-Datei mit eindeutigen Parametern versehen. Das betrifft insbesondere die Portnummern und den Hostnamen.

Datensicherung

Die Dokuplan-Daten sind in einer Mysql-Datenbank gespeichert. Die Datenbank ist im Docker-Volume db abgelegt. Bilder und Dokumente werden im Docker-Volume data als plain files gespeichert. Ein täglicher inkrementeller Backup der dieser Daten liegt im Docker-Volume backup.

Zur Verwaltung der Datenbank kann die Webanwendung Adminer benutzt werden. Geben Sie dazu in Ihrem Browser folgende Adresse ein:

http://<adresse_ihres_servers>:9000