Docusnap X – Docusnap Web€¦ · Die Docusnap Server API wird im Standard über Port 9001...

Docusnap X – Docusnap Web Docusnap Web installieren und anpassen

Docusnap Web installieren und anpassen | itelio GmbH

Docusnap X – Docusnap Web | ©2017 Docusnap – Alle Rechte vorbehalten Seite 2 von 24

Die Weitergabe, sowie Vervielfältigung dieser Unterlage, auch von Teilen, Verwertung und Mitteilung ihres Inhaltes ist nicht gestattet, soweit nicht ausdrücklich durch die itelio GmbH zugestanden. Zuwiderhandlung verpflichtet zu Schadenersatz. Alle Rechte vorbehalten.

This document contains proprietary information and may not be reproduced in any form or parts whatsoever, nor may be used by or its contents divulged to third parties without written permission of itelio GmbH. All rights reserved.

TITEL Docusnap X – Docusnap Web AUTOR Docusnap Consulting DATUM 12.07.2017 VERSION 1.4 | gültig ab 06.09.2016 SPRACHE Deutsch



INHALTSVERZEICHNIS

Einleitung 4

1.1 Themenüberblick – Docusnap Web 4

1.2 Installation Docusnap Web - Voraussetzungen 4

1.3 Docusnap Web – Architektur 5

Installation von Docusnap Web 6

2.1 Docusnap Web – Automatische Installation 6

2.2 Docusnap Web – Manuelle Installation 7

2.2.1 Docusnap Web - Manuelle Installation - Installationsschritte 7

2.3 Docusnap Web – Die erste Anmeldung 9

Optional: Anpassung der Ports von Webserver und Docusnap Server API 11

3.1 Einleitung 11

3.2 Konfiguration des Zugriffs auf IIS (statische Webseite) auf http – Port 80 11

3.3 Zugriff auf die Docusnap Server API per https – Konfiguration von Port 443 15

3.3.1 Anpassung der Server API Verbindung 16

3.4 Docusnap Web - Verbindungstest mit einem Endgerät 18

Administration von Benutzerzugriffen auf Docusnap Web 19

4.1 Aktivierung der Benutzerverwaltung 19

4.2 Konfiguration des Authentifizierungsschemas von Docusnap Web 21 4.2.1 Anonyme Authentifizierung 21 4.2.2 Basis Authentifizierung 21 4.2.3 Integrierte Windows-Authentifizierung 21



Einleitung

Mit Docusnap X ist es per Browser möglich, mit beliebigen Endgeräten auf Daten Ihrer Docusnap Datenbank lesend zuzugreifen, sowie Pläne und Berichte zu erstellen.

1.1 Themenüberblick – Docusnap Web

• Kapitel 2 – Automatische und manuelle Installation von Docusnap Web • Kapitel 3 – Best Practice: Anpassung der Ports von Webserver u. Docusnap Server API • Kapitel 4 – Benutzerzugriffe auf Docusnap Web administrieren

1.2 Installation Docusnap Web - Voraussetzungen

• Vollständige Docusnap Installation und Konfiguration

Ein entsprechendes How-To ist in unserer How-To-Sektion zu finden - Docusnap X - Installation und Konfiguration

• Konfiguration des Docusnap-Servers-Dienstes

Für die Installation von Docusnap Web wird mindestens Windows 8 / Windows 2012 oder höher vorausgesetzt!

http://www.docusnap.com/support/how-to



1.3 Docusnap Web – Architektur

Auf dem Docusnap System wird ein IIS Webserver installiert und eine statische Webseite angelegt. Diese Webseite verbindet sich mit dem Docusnap Serverdienst auf Ihrer Docusnap Datenbank. Nun werden, mit Hilfe des Browsers, die gewünschten Inhalte von der Datenbank angefordert und auf dem Endgerät angezeigt.

Docusnap Server

Docusnap Server Dienst

Docusnap Datenbank

Web Browser

IIS

Browser

Datenbank Informationen – Standard Port 9001

Statische WebSite - Standard Port 8181

Abbildung 1 – Docusnap Web Architekturübersicht

Wichtig: Es wird ein Port für den Zugriff auf den IIS-Webserver benötigt, um die statische Webseite im Browser aufzurufen. Ein weiterer Port ist erforderlich, um auf die Docusnap Server API zuzugreifen. Über diese Schnittstelle werden die, in der Docusnap Datenbank vorhandenen, Informationen in den Browser geladen.

Es ist sicherzustellen, dass Ihr Docusnap System über diese Ports, von den Docusnap Web Endgeräten, angesprochen werden kann!

Der Standard Port für den IIS Webserver ist 8181. Die Docusnap Server API wird im Standard über Port 9001 angesprochen. In Kapitel drei wird erläutert, wie diese Ports auf Port 80 http und Port 443 https angepasst werden können.



Installation von Docusnap Web

2.1 Docusnap Web – Automatische Installation

Nach durchgeführter Grundinstallation von Docusnap X erscheint, beim ersten Start von Docusnap X, ein Konfigurationsdialog. Wird hier „Docusnap Web installieren“ gewählt, werden automatisch alle IIS Komponenten installiert, die Docusnap Webseite auf Port 8181 erstellt und für den anonymen Zugriff freigeschaltet.

Für diese Installationsart sind keine zusätzlichen Schritte erforderlich. Docusnap Web wird somit, ohne die Notwendigkeit weiterer Schritte, vollständig im Standard installiert.

Abbildung 2 – Docusnap X , erster Start Konfigurationsassistent



2.2 Docusnap Web – Manuelle Installation

Wurde beim ersten Aufruf von Docusnap X die Option Docusnap Web installieren nicht gewählt, sind für eine nachträgliche Installation die hier beschriebenen Schritte durchzuführen.

2.2.1 Docusnap Web - Manuelle Installation - Installationsschritte Die Datei DocusnapWebSetup.exe befindet sich im Programmverzeichnis von Docusnap X im Unterverzeichnis Setup.

Abbildung 3 - Position Setupdatei im Filesystem



Im Folgenden wird der zu durchlaufende Setup Dialog angezeigt. Die Installation der IIS–Komponenten und das Anlegen der Docusnap Webseite erfolgt im Hintergrund. Es sind ein paar Minuten zu kalkulieren bis diese Installation abgeschlossen ist:

Abbildung 4 - Docusnap Web Setup – Installationsschritte



2.3 Docusnap Web – Die erste Anmeldung

Im gewählten Browser wird der Docusnap Web Anmeldedialog angezeigt. Der lokale Aufruf von Docusnap Web erfolgt über die URL http://localhost:8181

Abbildung 5 - Docusnap Web Anmeldedialog

Über den Anmeldedialog wird festgelegt, von welchem Docusnap Server die Informationen abgerufen werden. Zusätzlich werden, abhängig von der Authentifizierungsmethode, die Anmeldeinformationen abgefragt und der benötigte Mandant festgelegt.

Im Feld Docusnap Server URL ist einzutragen mit welchem Protokoll (http oder https) und über welchen Port die Docusnap Server API erreichbar ist.

Wurden keine Anpassungen durchgeführt, ist die Docusnap Server API über folgende URL erreichbar:

http://HOSTNAME:9001

http://localhost:8181/



Die URL der Server API kann unter Allgemeine Optionen - Verbindungen - Server API Verbindung ermittelt werden.

Abbildung 6 - Docusnap Server API - URL ermitteln



Optional: Anpassung der Ports von Webserver und Docusnap Server API

3.1 Einleitung

In einer Produktivumgebung sind Port 8181 (Zugriff IIS – statische Webseite) und Port 9001 (Zugriff auf Docusnap Server API) unter Umständen nicht freigegeben. In diesem optionalen Kapitel wird beschrieben, wie, ausgehend von der Standardkonfiguration, der Zugriff auf den Docusnap IIS Webserver auf http Port 80 und der Zugriff auf die Docusnap Server API auf https Port 443 geändert wird. Eine Kommunikation über diese Ports sollte in den meisten Umgebungen möglich sein. Zusätzlich wird für die Abfragen der Datenbank durch den Browser die Sicherheit erhöht, da, durch die Verwendung von https, der Datentransport verschlüsselt stattfindet.

3.2 Konfiguration des Zugriffs auf IIS (statische Webseite) auf http – Port 80

Auf dem System befindet sich, nach der erfolgreichen Installation von Docusnap Web, ein IIS Server der zwei Webseiten hostet:

• Default Web Site (Port 80) • Docusnap Web (Port 8181)

Abbildung 7 - IIS Manager - vorhandene Webseiten



Im ersten Schritt wird per Rechtsklick auf die Default Web Site - Bindungen bearbeiten der Port von 80 auf 81 angepasst. Im zweiten Schritt wird Docusnap Web auf den nun freien Port 80 konfiguriert:

Abbildung 8 - IIS Manager – Edit Bindings Dialog starten

Abbildung 9 - IIS Manager - Docusnap Web auf Port 80



Damit die Änderungen greifen, ist es erforderlich, den IIS Server neu zu starten. Dies kann u.a. im IIS-Manager, auf der rechten Seite, unterhalb von Aktionen - Website verwalten, durchgeführt werden.

Abbildung 10 - IIS Server Neustart

Alternativ kann auch eine CMD-Konsole - als Administrator - geöffnet und der Befehl iisreset abgegeben werden.

Abbildung 11 - iisreset



Nun kann der Aufruf des Docusnap Webclients über den Aufruf http://hostname erfolgen.

Abbildung 12 - Aufruf des Webclients nach der Änderung



3.3 Zugriff auf die Docusnap Server API per https – Konfiguration von Port 443

Der Wechsel von http auf https erfordert für die Verschlüsselung ein Zertifikat. In diesem Beispiel wird beschrieben, wie innerhalb von Docusnap ein selbstsigniertes Zertifikat erstellt und die Docusnap Server API auf https mit Port 443 konfiguriert wird. Dazu ist der Docusnap Server Konfigurationsdialog zu starten.

Es müssen nur Einstellungen in der Sektion 4 - Server API geändert werden.

Abbildung 13 - Docusnap Server Konfiguration – Server API

Es können nun folgende Einstellungen konfiguriert werden: - Schema

o Zugriff per http oder https - Zertifikat auswählen - wenn https als Schema gewählt wurde

o Ein bereits vorhandenes Zertifikat kann ausgewählt werden o Ist kein Zertifikat vorhanden, wird im Zuge der Konfiguration ein neues, selbstsigniertes

Zertifikat erstellt - Authentifizierungsschema

o Authentifizierung für den Zugriff auf Docusnap Web o Wird im folgenden Kapitel behandelt



Nachdem alle Eigenschaften konfiguriert und die Konfiguration abgeschlossen ist, wird das Zertifikat installiert. Dies muss bestätigt werden.

Abbildung 14 - Betriebssystem Warnung - Zertifikat installieren

3.3.1 Anpassung der Server API Verbindung

Die durchgeführte Änderung, bezüglich des Authentifizierungsschemas der Server API, muss im nächsten Schritt, in der Server API Verbindungs URL, angepasst werden.

Diese Einstellung ist unter Allgemeine Optionen - Verbindungen - Server API Verbindung zu setzen. Der Verbindungstest prüft die korrekte Einrichtung.

Abbildung 15 - Server API Connection anpassen und testen



Nachdem der Dialog geschlossen wurde, sollte im Statusbereich von Docusnap die Information erscheinen, dass zwei Discoveries aktiv und über https verbunden sind. Somit ist die Umstellung auf https auf Port 443 abgeschlossen. Unter Umständen ist es erforderlich den Docusnap Server Dienst neu zu starten.

Abbildung 16 - Status Discoveries



3.4 Docusnap Web - Verbindungstest mit einem Endgerät

Die durchgeführten Änderungen werden von einem anderen System im Netzwerk getestet. Dieses Windows System kann den Hostnamen des Docusnap Rechners auflösen. Die URL im Eingabefeld „Docusnap Server URL“ wird angepasst. Das Protokoll wird auf https geändert. Port 443 ist der https Standard Port und muss deshalb nicht angegeben werden.

Beim Aufruf muss das selbstsignierte Docusnap Server Zertifikat akzeptiert werden. Der Firefox Browser hat hiermit Probleme. Alle anderen getesteten Browser akzeptierten bei unseren Tests das Zertifikat.

Sicherheitshinweis - Dieser Dialog ist zu bestätigen. Nachdem dieser Dialog abgeschlossen ist, startet der Docusnap Web Client.

Ob diese Sicherheitsabfragen angezeigt werden, hängt davon ab, mit welchem Zertifikat die https Verbindung zur Docusnap Server API konfiguriert wurde.

Abbildung 17 - Sicherheitswarnung Betriebssystem



Administration von Benutzerzugriffen auf Docusnap Web

Das Authentifizierungsschema für den Zugriff auf Docusnap Web kann, im Zuge der Docusnap Server (Server API) Konfiguration, verändert werden. Voraussetzung hierfür ist die aktivierte Benutzerverwaltung. Ohne aktivierte Benutzerverwaltung erfolgt der Zugriff mittels der Anonymen Authentifizierung - somit hat Jeder Zugriff auf den Docusnap Webclient.

4.1 Aktivierung der Benutzerverwaltung

Die Benutzerverwaltung von Docusnap wird unter Administration - Allgemein verwaltet.

Abbildung 18 - Benutzerverwaltung

Innerhalb der Benutzerverwaltung können folgende Informationen verwaltet werden:

- Benutzer / Gruppe - entweder aus der Domäne oder dem lokalen Systems - Beschreibung - Zugriff auf Webclient - Passwort für Basic Authentifizierung - Docusnap Rolle

Weitere Informationen bezüglich der Benutzerverwaltung in Docusnap sind im Online Handbuch zu finden.

http://www.docusnap.com/en/manual/configuration/index.html?Docusnap-Management-User-Management-Users.htm



Für die Nutzung der Authentifizierungsmethoden Integrierte Windows Authentifizierung oder Basis Authentifizierung müssen die entsprechenden Benutzer oder Gruppen in der Benutzerverwaltung angelegt und die Option Zugriff auf den Webclient erlauben aktiviert werden.

Wird die Basis Authentifizierung für den Zugriff auf den Webclient genutzt, muss ein entsprechendes Passwort eingegeben werden. Für die Nutzung der integrierten Authentifizierung ist keine Passworteingabe notwendig.

Sollen Benutzer hinzugefügt werden, die nur Zugriff auf den Webclient besitzen sollen, benötigen diese keine Zuordnung zu einer Rolle.

WICHTIG: Die Benutzer oder Gruppen, welche den Docusnap Client nutzen, müssen den entsprechenden Benutzerrollen zugeordnet werden!

Abbildung 19 - Benutzer für die integrierte Windows Authentifizierung hinzufügen



4.2 Konfiguration des Authentifizierungsschemas von Docusnap Web

Das Authentifizierungsschema, für den Zugriff auf den Webclient, ist wieder im Konfigurationsvorgang des Docusnap Server zu finden - 4 - Server API.

Abbildung 20 - Authentifizierungsschema auswählen

4.2.1 Anonyme Authentifizierung

Wird diese Art der Authentifizierung gewählt, erfolgt am IIS keine Prüfung. Jeder Anwender, der (netzwerk-technisch) dieses System erreicht, kann den Docusnap Webclient öffnen.

4.2.2 Basis Authentifizierung

Wird diese Authentifizierung gewählt, muss zusätzlich eine Benutzerkennung mit Passwort eingegeben werden, damit auf Docusnap Web zugegriffen werden kann. Diese Daten werden in Klarschrift übertragen. Deshalb sollte für diese Methode die Docusnap Server API auf https konfiguriert sein. Diese Methode kann dann verwendet werden, wenn:

• Anonyme Authentifizierung nicht erwünscht ist • Integrierte Windows-Authentifizierung nicht möglich ist (z.B. System in Arbeitsgruppe oder außerhalb

des Intranets)

4.2.3 Integrierte Windows-Authentifizierung

Mit dieser Methode wird geprüft, ob der angemeldete Domänen- oder Systembenutzer in der Docusnap Benutzerverwaltung freigeschaltet wurde und zusätzlich, ob der Webzugriff erlaubt ist. Der Zugriff auf Docusnap Web erfolgt hier ohne die Notwendigkeit, Anmeldeinformationen einzutragen. Diese Art der Authentifizierung ist am aufwändigsten, bietet aber die höchste Sicherheit. Bereits in den vorangegangenen Versionen von Docusnap war es möglich, den Zugriff auf Docusnap, auf diesem Weg zu beschränken. Mit Docusnap X wurde diese Funktionalität um Docusnap Web erweitert.



ABBILDUNGSVERZEICHNIS

ABBILDUNG 1 – DOCUSNAP WEB ARCHITEKTURÜBERSICHT ............................................................................................................... 5

ABBILDUNG 2 – DOCUSNAP X , ERSTER START KONFIGURATIONSASSISTENT ............................................................................ 6 ABBILDUNG 3 - POSITION SETUPDATEI IM FILESYSTEM ........................................................................................................................ 7

ABBILDUNG 4 - DOCUSNAP WEB SETUP – INSTALLATIONSSCHRITTE............................................................................................. 8

ABBILDUNG 5 - DOCUSNAP WEB ANMELDEDIALOG ............................................................................................................................. 9

ABBILDUNG 6 - DOCUSNAP SERVER API - URL ERMITTELN................................................................................................................10

ABBILDUNG 7 - IIS MANAGER - VORHANDENE WEBSEITEN............................................................................................................... 11

ABBILDUNG 8 - IIS MANAGER – EDIT BINDINGS DIALOG STARTEN .................................................................................................12 ABBILDUNG 9 - IIS MANAGER - DOCUSNAP WEB AUF PORT 80 ......................................................................................................12

ABBILDUNG 10 - IIS SERVER NEUSTART ......................................................................................................................................................13

ABBILDUNG 11 - IISRESET .................................................................................................................................................................................13 ABBILDUNG 12 - AUFRUF DES WEBCLIENTS NACH DER ÄNDERUNG ............................................................................................. 14

ABBILDUNG 13 - DOCUSNAP SERVER KONFIGURATION – SERVER API ..........................................................................................15

ABBILDUNG 14 - BETRIEBSSYSTEM WARNUNG - ZERTIFIKAT INSTALLIEREN ................................................................................16 ABBILDUNG 15 - SERVER API CONNECTION ANPASSEN UND TESTEN ...........................................................................................16

ABBILDUNG 16 - STATUS DISCOVERIES ...................................................................................................................................................... 17

ABBILDUNG 17 - SICHERHEITSWARNUNG BETRIEBSSYSTEM ..............................................................................................................18 ABBILDUNG 18 - BENUTZERVERWALTUNG ...............................................................................................................................................19

ABBILDUNG 19 - BENUTZER FÜR DIE INTEGRIERTE WINDOWS AUTHENTIFIZIERUNG HINZUFÜGEN .................................. 20

ABBILDUNG 20 - AUTHENTIFIZIERUNGSSCHEMA AUSWÄHLEN........................................................................................................21



VERSIONSHISTORIE

Datum Beschreibung

05.08.2016 Version 1.0 – Erster Draft

08.08.2016 Version 1.1 – Erweiterung um Kapitel Portanpassung u. Zertifikatshandling

09.08.2016 Version 1.2 – Korrekturen (Feedback Entwicklung)

02.09.2016 Version 1.3 - Anpassungen an RTM Version von Docusnap X

14.09.2016 Version 1.4 – Statusleiste Docusnap X Screenshot u. Handling privater Zertifikate aktualisiert

Docusnap X – Docusnap Web€¦ · Die Docusnap Server API wird im Standard über Port 9001...

Documents

Transcript of Docusnap X – Docusnap Web€¦ · Die Docusnap Server API wird im Standard über Port 9001...