changeset 1005:4b4fb980272b

(manual) Updated all sections in help manual.
author Emanuel Schuetze <emanuel@intevation.de>
date Mon, 01 Sep 2014 15:39:52 +0200 (2014-09-01)
parents 29783ef4da62
children b75bd6686f43
files manuals/help-manual/_static/nsis-installer.png manuals/help-manual/bedienung.rst manuals/help-manual/faq.rst manuals/help-manual/index.rst manuals/help-manual/installation.rst
diffstat 5 files changed, 113 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
Binary file manuals/help-manual/_static/nsis-installer.png has changed
--- a/manuals/help-manual/bedienung.rst	Mon Sep 01 15:05:48 2014 +0200
+++ b/manuals/help-manual/bedienung.rst	Mon Sep 01 15:39:52 2014 +0200
@@ -13,3 +13,91 @@
    :alt: Die TrustBridge-Oberfläche unter Windows bei verfügbaren Zertifikatsänderungen
    :width: 100%
 
+
+Seite "Neue Empfehlungen"
+-------------------------
+
+Neue Zertifikatsänderungen schreiben:
+.....................................
+Sind neue Zertifikatsaktualisierungen vom BSI verfügbar, werden Sie
+über die empfohlenen Änderungen auf dieser Seite informiert. Im Titel
+finden Sie die Gesamtanzahl der vorgeschlagenen Zertifikatsänderungen.
+Über den Button *[Änderungen schreiben]* können Sie diese Änderungen
+vollständig übernehmen.
+
+Details zu den empfohlenen Zertifikaten (wie z.B. Zertifikatsinhaber,
+Gültigkeit, Fingerabdruck) lassen sich im unteren Teil der Seite über
+die beiden Gruppierungen mittels der *[Details]* Button einblenden:
+
+* Neue, empfohlene Wurzelzertifikate installieren (n/n)
+* Abgeratene Wurzelzertifikate entfernen (n/n)
+
+An dieser Stelle haben Sie die Möglichkeit (*vor* dem Schreiben der
+Änderungen) ausgewählte Zertifikate "abzuwählen". Dadurch werden diese
+Zertifikate *nicht* installiert bzw. entfernt.  Solche
+Abwahlentscheidungen können Sie später jederzeit wieder auf den Seiten
+"Empfohlene Wurzelzertifikate" und "Abgeratene Wurzelzertifikate"
+korrigieren.
+
+Suche nach Aktualisierungen:
+............................
+Beim Start der Anwendung wird automatisch nach neuen Aktualisierungen
+(Software und Zertifikaten) gesucht. Über den Button *[Aktualisieren]*
+kann diese Suche auch manuell angestoßen werden. Der letzte
+Suchzeitpunkt wird daneben angezeigt.
+
+Wurzelzertifikate erneut schreiben:
+...................................
+Sind alle Zertifikatsänderungen eingespielt und liegen keine
+Änderungen vor, können alle von TrustBridge verwalteten Zertifikate
+noch einmal installiert werden. Dafür muss auf den Button
+*[Wurzelzertifikate erneut schreiben]* geklickt werden.  Hilfreich
+könnte diese Funktion sein, wenn seit der letzten Aktualisierung durch
+TrustBridge im Zertifikatsspeicher *manuell* Zertifikate geändert
+wurden. Um den durch TrustBridge empfohlenen Stand wiederherzustellen,
+klickt man einmal auf o.g. Schaltfläche.
+
+
+Seite "Empfohlene Wurzelzertifikate"
+------------------------------------
+Alle Wurzelzertifikate, die TrustBridge aktuell zur Installation
+vorgeschlagen hat, sind auf dieser Seite einsehbar. Jedes Zertifikat
+kann einzeln "abgewählt" werden, d.h. es wird mit der nächsten
+*[Änderungen schreiben]*-Aktion entfernt.  Bereits "abgewählte"
+Zertifikate können analog so zur Installation markiert werden.
+
+Jede manuelle Änderung, die Sie hier vornehmen, wird auf der Seite
+"Neue Empfehlungen" aufgelistet. Die Anzahl der "abweichend zu
+behandelnden Wurzelzertifikate" wird auch auf der Schaltfläche "Neue
+Empfehlungen" im roten Kreis angezeigt.
+
+**Achtung:** TrustBridge zeigt *nicht* den tatsächlichen
+Installationszustand eines Zertifikats im Zertifikatsspeicher an.
+TrustBridge selbst kann nur ausgewählte Zertifikate in alle
+Zertifikatsspeicher "einspielen".  Eine Kontrolle, dass in der
+Zwischenzeit diese Zertifikate nicht verändert wurden, kann
+TrustBridge nicht geben.
+
+
+Seite "Abgeratene Wurzelzertifikate"
+------------------------------------
+Alle Wurzelzertifikate, die TrustBridge zur Deinstallation
+vorgeschlagen hat, werden auf dieser Seite aufgelistet.  Bereits
+deinstallierte Zertifikate lassen sich mit TrustBridge nicht mehr
+installieren.
+
+Sollten Sie Zertifikate bei der Aktualisierung "zurückgehalten" haben,
+d.h. noch nicht zur Deinstallation freigegeben haben, können Sie das
+Zertifikat über das Auswahlfeld zur Deinstallation markieren.  Damit
+das Zertifikat endgültig aus allen Zertifikatsspeichern gelöscht wird
+müssen Sie anschließend den *[Änderungen schreiben]*-Button auf der
+Seite "Neue Empfehlungen" bestätigen.
+
+
+Seite "Information und Hilfe"
+-----------------------------
+Neben der Erwähnung von Herstellers und Lizenz von TrustBridge finden
+Sie hier die Möglichkeit:
+
+* diese TrustBridge-Hilfe zu starten und
+* die Proxy-Server-Einstellungen vorzunehmen.
--- a/manuals/help-manual/faq.rst	Mon Sep 01 15:05:48 2014 +0200
+++ b/manuals/help-manual/faq.rst	Mon Sep 01 15:39:52 2014 +0200
@@ -101,7 +101,7 @@
 
 #. Verfügbarkeit von Aktualisierungen prüfen:
    Die regelmäßige Übertragung der Information, ob neue Aktualisierungen
-   von Zertifiaktsliste oder Software verfügbar sind, wird über eine
+   von Zertifikatsliste oder Software verfügbar sind, wird über eine
    HTTPS-Verbindung per TLS 1.2 (mit ECDSA brainpoolP256r1) durchgeführt.
 #. Zertifikatslisten-Update durchführen:
    Ist eine neue Zertifikatsliste verfügbar, wird die ganze Liste
--- a/manuals/help-manual/index.rst	Mon Sep 01 15:05:48 2014 +0200
+++ b/manuals/help-manual/index.rst	Mon Sep 01 15:39:52 2014 +0200
@@ -1,27 +1,31 @@
 Was ist TrustBridge?
 ====================
 
-TrustBridge ist eine Anwendung vom `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_ für die Verbreitung von empfohlenen Wurzelzertifikaten.
+TrustBridge ist eine Anwendung vom `Bundesamt für Sicherheit in der
+Informationstechnik (BSI) <https://bsi.bund.de>`_ für die Verbreitung
+von empfohlenen Wurzelzertifikaten.
 
 TrustBridge macht es Nutzern einfacher, Wurzelzertifikate für eine
 X.509-basierende, öffentliche Zertifikatsinfrastruktur (PKI)
 einzuspielen und aktuell zu halten. TrustBridge verteilt
 Wurzelzertifikate, welche von den Betriebssystemen und Webbrowsern
 nicht mitgeliefert werden. Existierende Zertifikate, die korrumpiert
-oder missbraucht wurden, können von TrustBridge über eine Deinstallations-Empfehlung
-entfernt werden.  Dabei ist unerheblich, ob die
-Zertifikate auf der Anwenderebene vorher bereits installiert waren.
+oder missbraucht wurden, können von TrustBridge über eine
+Deinstallations-Empfehlung entfernt werden.  Dabei ist unerheblich, ob
+die Zertifikate auf der Anwenderebene vorher bereits installiert
+waren.
 
-**Wurzelzertifikate** (auch Rootzertifikate genannt) sind die Basis einer PKI zur Feststellung der
-Authentizität des Kommunikationspartners und der Integrität seiner
-Nachrichten für verschiedene Anwendungen -- insbesondere bei der
-Übertragung über unsichere Kommunikationskanäle, wie dem Internet.
+**Wurzelzertifikate** (auch Rootzertifikate genannt) sind die Basis
+einer PKI zur Feststellung der Authentizität des
+Kommunikationspartners und der Integrität seiner Nachrichten für
+verschiedene Anwendungen -- insbesondere bei der Übertragung über
+unsichere Kommunikationskanäle, wie dem Internet.
 
-Ein Wurzelzertifikat dient als Vertrauensanker
-("Trust Anchor") für alle darunter hängenden Zertifikate. Unterhalb
-der Wurzel folgt eine Sicherheitskette ("Trust Chain") von ein oder
-mehreren Zwischenzertifikaten der Zertifizierungsstellen, gefolgt von
-den ausgestellten Zertifikaten für die Anwendungen. Die Zertifikate
+Ein Wurzelzertifikat dient als Vertrauensanker ("Trust Anchor") für
+alle darunter hängenden Zertifikate. Unterhalb der Wurzel folgt eine
+Sicherheitskette ("Trust Chain") von ein oder mehreren
+Zwischenzertifikaten der Zertifizierungsstellen, gefolgt von den
+ausgestellten Zertifikaten für die Anwendungen. Die Zertifikate
 sichern per Public-Key-Kryptoverfahren nach dem X.509-v3 Standard
 beispielsweise TLS-Verbindungen von Webbrowser zu Webserver (HTTPS)
 oder E-Mail-Klient zu E-Mail-Server (IMAPS). Ein weiteres Beispiel ist
@@ -30,9 +34,9 @@
 
 Über diese Hilfe
 ================
-Diese Hilfe unterstützt Sie bei der Bedienung von TrustBridge |version| sowie
-vermittelt Ihnen ein beseres Verständnis was die Anwendung macht und
-wofür das gut ist. Die Hilfeseiten im Überblick:
+Diese Hilfe unterstützt Sie bei der Bedienung von TrustBridge
+|version| sowie vermittelt Ihnen ein beseres Verständnis was die
+Anwendung macht und wofür das gut ist. Die Hilfeseiten im Überblick:
 
 .. toctree::
    :maxdepth: 2
@@ -45,7 +49,8 @@
 Impressum
 =========
 
-Copyright 2014 Die Rechte liegen beim `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_.
+Copyright 2014 Die Rechte liegen beim `Bundesamt für Sicherheit in der
+Informationstechnik (BSI) <https://bsi.bund.de>`_.
 
 TrustBridge wurde von den Unternehmen `Intevation GmbH
 <http://www.intevation.de>`_ und `DN-Systems GmbH
--- a/manuals/help-manual/installation.rst	Mon Sep 01 15:05:48 2014 +0200
+++ b/manuals/help-manual/installation.rst	Mon Sep 01 15:39:52 2014 +0200
@@ -48,8 +48,8 @@
 Für die Installation von TrustBridge unter Ubuntu wird ein interaktives Installationsskript
 für die Kommandozeile angeboten - jeweils ein Script für 32 und 64 Bit-Systeme.
 
-Führen Sie das Skript ohne Option aus, um Trustbridge **lokal** in Ihrem Home-Verzeichnis zu installieren
-(standardmäßg unter ``/home/TrustBridge/``).
+Führen Sie das Skript ohne Option aus, um TrustBridge **lokal** in Ihrem Home-Verzeichnis zu installieren
+(standardmäßig unter ``/home/TrustBridge/``).
 
 Für 64-Bit-Systeme:
 

http://wald.intevation.org/projects/trustbridge/