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 in Ihrem Rechenzentrum betreiben. Für iOS und Android gibt es eine Dokuplan-App, die nach dem Prinzip offline first arbeitet.

Inhaltsverzeichnis

Erste Schritte

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.

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

Bevor die Aufnahme der Anlagen-Bauteile 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 20.04 LTS.

Voraussetzungen

Auf dem Dokuplan-Server muss Ubuntu 20.04 LTS installiert sein.
Administration über Kommandozeile bzw. SSH.
Software-Paket-Datei dokuplan_<version>_amd64.deb
Dokuplan Serverlizenz
Server Zertifikate für HTTPS
Optional: Scandit Lizenz

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

Kopieren Sie die Software-Paket-Datei dokuplan_<version>_amd64.deb in ein Verzeichnis Ihrer Wahl.
Wechseln Sie in dieses Verzeichnis und installieren Sie Dokuplan mit dem Kommando

sudo apt install -f dokuplan_<version>_amd64.deb

Wechseln Sie in das neu entstandene Verzeichnis /etc/dokuplan.
Ersetzen Sie die Platzhalter-Dateien dokuplan_license, scandit_licensekey.txt durch Ihre Lizenzdateien. Die Platzhalter-Dateien https.pfx und certpw sind Schlüssel und Passwort für das Server-Zertifikat, das für HTTPS benötigt wird. Diese beiden Dateien müssen Sie ebenfalls ersetzen.
Laden Sie den Dokuplan-Service neu 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	Passwort 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

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 und auf dem SMB-Share dpbackup für den Gast-Account bereitgestellt. Von dort können sie in die unternehmensweite Datensicherung übernommen werden.

Einstellungen

Passen Sie die Einstellungen in /etc/backupninja.conf an, insbesondere die Parameter reportemail und when.
In /etc/samba/smb.conf wird das Backup Volume konfiguriert.
In /etc/backup.d wird festgelegt, welche Daten gesichert werden.

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. 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 installiert sein.
Archiv-Datei Dokuplan-Installer.zip
Dokuplan Serverlizenz
Server Zertifikate für HTTPS
Optional: Scandit Lizenz

Installationsschritte

Entpacken Sie die Archiv-Datei Dokuplan-Installer.zip in ein Verzeichnis Ihrer Wahl.
Wechseln Sie in das neu entstandene Verzeichnis dokuplan.
Kopieren Sie die Datei dokuplan_license in dieses Verzeichnis.
Wenn Sie eine Lizenz für Barcode-Scanning mit Geräte-integrierter Kamera erworben haben, so legen Sie die Textdatei scandit_license.txt an und füllen sie mit dem Lizenzcode.
Erzeugen Sie die Dateien cert.pfx und certpw.txt, das sind Schlüssel und Passwort für das Server-Zertifikat, das für HTTPS benötigt wird.
Installieren und starten Sie Dokuplan mit dem Kommando docker-pull.sh oder docker-pull.cmd, je nach Betriebssystem.

Die Port-Nummern {40000, 40001, 40006, 40002} bilden die öffentliche Schnittstelle des Docker-Containers. Sie können in der Konfigurationsdatei docker-compose.yml verändert werden.

Mehrere Mandanten

Wenn Sie mehrere Mandanten oder Instanzen nutzen wollen, müssen Sie je Mandant einen Dokuplan-Docker-Container starten und jeweils die docker-compose.yml-Datei mit eindeutigen Parametern versehen.

Datensicherung

Die Dokuplan-Daten sind in einer Mysql-Datenbank gespeichert, ausgenommen Bilder und Dokumente. Diese werden in einem Docker-Volume als plain files gespeichert.

Datenbank

Die Datenbank kann mit mysqldump gesichert werden. Die Zugriffs-Parameter sind:

dbhost = adresse_ihres_servers
dbport = 40006
dbname = dokuplan2
dbusername = root
dbpassword = xxxxxx

Gesichert wird mit dem Kommando:

mysqldump -B -u <dbusername> -p<dbpassword> --host=<dbhost> --port=<dbport> <dbname>

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

http://<adresse_ihres_servers>:40002

Bilder und Dokumente

Bilder und Dokumente werden im Upload-Ordner abgelegt. Dieser Ordner hat innerhalb des Docker-Containers den Pfadnamen /app/wwwroot/upload. Aus Sicht des Docker-Hosts ist der Pfadname abhängig vom Betriebssystem. Bei Ubuntu ist das /var/lib/docker/volumes/dokuplan_upload/_data/.

Anpassungen

Sie können die Portnummern ändern, die Dokuplan benutzen soll.
Wenn Sie mit gesicherter Verbindung arbeiten wollen (HTTPS), so müssen Sie ein eigenes Host-Zertifikat einsetzen.

Port-Nummern

Die Konfigurationsdatei docker-compose.yml hat in etwa folgenden Inhalt:

services:
  dokuplan:
    image: dokuplan
    ports:
      - "40000:5000"
      - "40001:5001"
    volumes:
      - upload:/app/wwwroot/upload

  db:
    image: mysql:5.7
        ports:
      - 40006:3306
    volumes:
      - mysql:/var/lib/mysql

  adminer:
    image: adminer:4.6.2
    ports:
      - 40002:8080

volumes:
  mysql:
  upload: