Quelltext der Seite Windows Installation

Gültig ab: EBKuS 4.10.1. (Frühere Versionen lassen sich aber ganz ähnlich installieren.)


=== Benötigte Software ===

* [https://www.python.org/ftp/python/2.7.18/python-2.7.18.msi Python 2.7.18]
* [https://files.pythonhosted.org/packages/27/06/596ae3afeefc0cda5840036c42920222cb8136c101ec0f453f2e36df12a0/MySQL-python-1.2.5.win32-py2.7.exe  MySQL-python-1.2.5]
* [https://github.com/mhammond/pywin32/releases/download/b228/pywin32-228.win32-py2.7.exe pywin32-228]
* [http://ftp.gwdg.de/pub/misc/mysql/Downloads/MySQL-5.1/mysql-essential-5.1.73-win32.msi MySQL 5.1.73]
* [https://archive.apache.org/dist/httpd/binaries/win32/httpd-2.2.25-win32-x86-openssl-0.9.8y.msi Apache 2.2]

Alle benötigten Dateien befinden sich auch auf dem  [https://ebkus.org/downloads/win32/ EBKuS FTP-Server]. 
Nur die ersten drei müssen manuell heruntergeladen
und installiert werden. Die übrigen werden bei Bedarf automatisch
heruntergeladen (sofern eine Internetverbindung besteht, ansonsten siehe unten).

Natürlich muss noch die neueste 
[http://www.ebkus.org/alle_downloads.html EBKuS-Software]
selbst heruntergeladen werden. 

=== Sonstige Voraussetzungen ===

* '''Betriebssystem''': Erfolgreich getestet auf Windows 10 Professional. Windows Server 2008 und später sowie auch frühere Windows Versionen sind möglich.
* Die von einer EBKuS-Installation verwendeten '''Ports''' dürfen nicht anderweitig verwendete werden:
** Port 443 für den Apache-Webserver mit SSL-Verschlüsselung (kann mit der Konfigurationsvariablen {{konfig|server_https_port}} verändert werden)
** Port 80 für den Apache-Webserver ohne SSL-Verschlüsselung (kann mit der Konfigurationsvariablen {{konfig|server_http_port}} verändert werden). Dieser Port wird allerdings von der Anwendung nicht benötigt; man kann damit aber überprüfen, ob der Webserver installiert ist unabhängig von EBKuS-Instanzen.
** Port 3306 für den MySQL-Datenbankserver 
** Die in der {{file|ebkus.conf||}} explizit genannten Ports für die EBKuS-Instanzen
* '''Administratorrechte''' für die Installation. Insbesondere muss bei neueren Windows-Systemen die Kommandozeile explizit mit Administratorrechten aufgerufen werden (rechtsklicken, mit Administratorrechten ausführen). Sonst gelingt die Einrichtung der Dienste nicht.
* Die von EBKuS verwendeten '''Namen für Dienste''' dürfen nicht in Gebrauch sein: {{code|Apache, MySQL}} sowie die mit {{code|EBKuS}} beginnenden Namen für die Instanzen.
* Keine Reste in der Registry von früheren Installationsversuchen :-)

=== Python installieren ===

Zuerst Python
* {{code|python-2.7.18.msi}}
und dann PyWin und MySQL-python
* {{code|pywin32-228.win32-py2.7.exe}}
* {{code|MySQL-python-1.2.5.win32-py2.7.exe}}
installieren. Standardinstallation für alle Benutzer. Zur Kontrolle kann man {{pfad4|Start|Programme|Python 2.7|Python (command line)}} aufrufen und dort folgende Eingaben machen:
  >>> import win32service
  >>>
  >>> import MySQLdb
  >>>
Beide Importe müssen ohne Fehlermeldungen funktionieren.

=== Nur Erstkonfiguration erzeugen ===

Die Beispiele gehen davon aus, dass die heruntergeladene EBKuS-Software im Verzeichnis {{file|C:\EBKuS-4.10.1}} liegt.

Wenn man die Option {{code|-c}} bzw. {{code|--config}} des {{code|install-py}}-Skripts verwendet, wird lediglich die Konfigurationsdatei {{file|c:\ebkus_installation\ebkus\ebkus.conf}} erzeugt und nichts weiter installiert. 
  C:\>cd EBKuS-4.10.1
  C:\EBKuS-4.10.1>python install.py -c c:\ebkus_installation
Die so entstandene {{file|c:\ebkus_installation\ebkus\ebkus.conf}} kann nun weiter bearbeitet und in der eigentlichen Installation verwendet werden.

=== Vollautomatische Testinstallation ===

Falls die oben genannten Voraussetzungen erfüllt sind (insbesondere freie Standardports 80 und 443), kann man eine vollautomatische Erstinstallation vornehmen (Eingabeaufforderung mit Administratorrechten ausführen!):
  C:\>cd EBKuS-4.10.1
  C:\EBKuS-4.10.1>python install.py c:\ebkus_installation
Den Fortgang der Installation sieht man auf der Konsole und in der Datei {{file|c:\ebkus_installation\install.log}}.

Wenn alles gut gegangen ist, erhält man eine funktionierende EBKuS-Installation mit zwei Instanzen, {{code|demo}} und {{code|muster_efb}}. Es gibt dann 4 neue Windows-Dienste: Apache, MySQL, EBKuS-demo und EBKuS-muster_efb. Den Zugriff auf die Instanzen erhält man über die URL {{code|<nowiki>https://localhost/ebkus/demo/</nowiki>}} bzw. {{code|.../muster_efb/}}.

Die dabei entstandene Datei {{file|c:\ebkus_installation\ebkus\ebkus.conf}} sollte man sichern, da sie den Ausgangspunkt für die endgültige Installation darstellt.

Die Testinstallation kann dann ganz oder teilweise wieder deinstalliert werden:
  C:\EBKuS-4.10.1>python uninstall.py --all c:\ebkus_installation
bzw.
  C:\EBKuS-4.10.1>python uninstall.py c:\ebkus_installation ebkus
Im ersten Fall wird auch der Webserver und die Datenbank deinstalliert, im zweiten nur die eigentliche EBKuS-Installation mitsamt allen Instanzen.

=== Installation mit vorhandenem Webserver und Datenbank ===

Mit
  C:\EBKuS-4.10.1>python install.py --no_mysql --no_apache c:\ebkus_installation
kann man eine Installation durchführen, wenn Apache und MySQL bereits vorhanden sind und nicht durch die EBKuS-Installation bereitgestellt werden sollen. Das Vorgehen ist dann ähnlich der [[Linux_Installation]]. Es muss manuell dafür gesorgt werden, dass die generierte Datei {{file|ebkus_httpd.conf}} in die Apachekonfiguration eingebunden wird, z.B. durch die Zeile 
  Include c:\ebkus_installation\ebkus\ebkus_httpd.conf
am Ende der Apache {{file|httpd.conf}}. Außerdem muss man nach der Installation und der Umkonfigurierung den Webserver manuell neu starten, damit er die neue Konfiguration übernimmt.

=== Anpassen der Konfiguration ===

In der Konfigurationsdatei {{file|ebkus.conf}} gibt es die Systemabschnitte {{code|[DEFAULT], [ebkus], [apache]}} und {{code|[openssl]}} sowie je einen Abschnitt für jede zu installierende Instanz.

Dokumentation aller Konfigurationsvariablen siehe [[Konfiguration]].

==== Systemabschnitte ====

Im Abschnitt {{code|[apache]}} wird für die Variable {{konfig|server_name}} typischerweise die IP-Adresse des Rechners eingetragen. Es kann auch {{code|0.0.0.0}} genommen werden, wenn der Rechner über mehrere Netzwerkkarten mit unterschiedlichen IP-Nummern verfügt und EBKuS über alle erreichbar sein soll. Der Standardwert ist hier {{code|localhost}}, womit EBKuS nur auf dem lokalen Rechner erreichbar wäre.

Falls die Standardports 80 und 443 nicht für EBKuS zur Verfügung stehen, müssen hier alternative freie Ports eingetragen werden. {{konfig|server_http_port}} dient nur zur Kontrolle des Apache Webservers ({{code|<nowiki>http://localhost/</nowiki>}} liefert "It works!"). Falls eine Alternative für {{konfig|server_https_port}} eingetragen wird, muss der Port in der URL aufgeführt werden, um die Anwendung anzusprechen.

SSL-Zertifikate werden bei der Installation automatisch erzeugt und die Pfade werden als Werte der Konfiguationsvariablen {{konfig|ssl_certificate_file}} und {{konfig|ssl_certificate_key_file}}
eingetragen. Es handelt sich um selbssignierte Zertifikate, die beim erstmaligen Aufruf mit dem Browser Sicherheitswarnungen auslösen, die man ignorieren muss, um auf die Anwendung zuzugreifen.
Wenn man über eigene Zertifikate verfügt, kann man die Pfade hier eintragen.

Des weiteren kann die Email-Adresse des Systemadministrators bei {{konfig| server_admin}} eingetragen werden (die evt. auf Fehlerseiten des Servers erscheint). Im Abschnitt {{code|[openssl]}} sollten die regionalen und organisatorischen Angaben angepasst werden, da sie auf dem erzeugten Zertifikat erscheinen (das man sich z.B. im Browser ansehen kann).

Sie können ein Passwort setzen für die Datenbankuser {{code|root}} (der Instanzdatenbanken löschen und erstellen kann):
  C:\>cd ebkus_installation\mysql5.1\bin
  C:\ebkus_installation\mysql5.1\bin>mysqladmin.exe -uroot  password ''Neues Passwort''
Dies muss dem Konfigurationsparameter {{konfig|database_admin_password}} zugewiesen werden.

Alle anderen Werte in den Systemabschnitten sollten nur in Ausnahmefällen verändert werden.

==== Instanzen ====

Der Name des Abschnitts muss identisch sein mit dem Wert der Variablen {{konfig|instance_name}}. Der Name muss mit einem Buchstaben beginnen und darf neben Ziffern und Buchstaben nur das Sonderzeichen '_' enthalten.

Mit der Variablen {{konfig|initial_content}} kann man einer Instanz eine Datei mit einem Datenbankdump (Sicherungsdatei) zuweisen, mit dem die Instanz initialisiert wird:
  initial_content: C:\backup\demo_braunschweig_backup_v4.8_2020-06-17_02-10-00.zip
bzw.
  initial_content: demo_braunschweig_backup_v4.8_2020-06-17_02-10-00.zip
Wenn nur der Dateiname angegeben ist, muss die Datei im Homeverzeichnis liegen ({{file|c:\ebkus_installation\ebkus\}}).
Damit ist es möglich, eine Instanz aus einer bestehenden Installation in eine Neuinstallation zu migrieren (siehe unten). 

Jede Instanz benötigt einen eigenen freien Port (Variable {{konfig|port}}).

=== Installation ohne Internetzugang ===

Wenn alle [http://www.ebkus.org/alle_downloads.html benötigte Software für Windows 32 bit] in das Verzeichnis {{file|c:\ebkus_installation\download}} kopiert werden, wird kein Internetzugang benötigt. 

Alternativ kann beim ersten Aufruf von {{code|install.py}} ein Downloadverzeichnis angegeben werden, in dem sich die Installationsdateien befinden müssen:
  C:\EBKuS-4.10.1>python install.py -d c:\ebkus_download c:\ebkus_installation
Wenn bereits eine {{file|ebkus.conf}} existiert, wird das in der Variable {{konfig|download_dir}} definierte Verzeichnis verwendet und die Option {{code|-d}} kann entfallen.

=== Migration ===

Die Migration beinhaltet die Übernahme der Instanzen aus einer bestehenden EBKuS-Installation in eine Neuinstallation mit der neuen Software. Die EBKuS-Version der bestehenden Installation muss mindestens 4.7 sein; ältere müssen erst im Rahmen der bestehenden Installation updatet werden.

==== Vorbereitung ====

Für die Migration muss eine für die Neuinstallation gültige {{file|ebkus.conf}} bereitgestellt werden sowie eine Sicherungsdatei für jede zu migrierende Instanz. Die Sicherungsdatei wird in der alten Installation mit dem Skript {{code|datenbank_sichern.py --zip ''Verzeichnis''}} erzeugt.
Die Zuordnung wird wie oben beschrieben für jede Instanz über die Konfigurationsvariable {{konfig|initial_content}} vorgenommen (nur Dateiname, ohne Pfadangabe). Ansonsten werden die Konfigurationen der Instanzen aus der alten {{file|ebkus.conf}} übernommen. Die Systemabschnitte für die neue {{file|ebkus.conf}} werden wie oben beschrieben aus der Testinstallation bzw. der Erstkonfiguration übernommen.

==== Neuinstallation ====

Die neu erstellte {{file|ebkus.conf}} wird zusammen mit den Sicherungsdateien in ein Verzeichnis kopiert, z.B. {{file|c:\ebkus_preconfig}}.
Vor der Neuinstallation sollte die alte Installation mit {{code|uninstall.py}} deinstalliert werden. Insbesondere sollte im Installationsverzeichnis
kein Verzeichnis {{code|ebkus}} mehr existieren.
Dem {{code|install.py}}-Skript wird das Verzeichnis mit der Option {{code|-p}} übergeben:
  C:\EBKuS-4.10.1>python install.py -p c:\ebkus_preconfig c:\ebkus_installation
Vor der Installation wird dann der Inhalt dieses Verzeichnisses vom Skript in das Homeverzeichnis kopiert, so dass die Installation durch die neue {{file|ebkus.conf}} gesteuert wird. 

=== Einzelne Instanzen ===

==== Entfernen ====

Mit Hilfe des {{code|uninstall.py}}-Skripts lassen sich auch einzelne Instanzen entfernen.
  C:\EBKuS-4.10.1>python uninstall.py c:\ebkus_installation ''Instanzname''
Das {{code|uninstall.py}}-Skript kann auch aus dem Homeverzeichnis aufgerufen werden.

Wichtig: Den Konfigurationsabschnitt der Instanz in der {{file|ebkus.conf}} erst nach der erfolgreichen Deinstallation entfernen! Sonst ist Handarbeit angesagt.

==== Hinzufügen ====

Als erstes muss in der {{file|ebkus.conf}} ein Abschnitt für die neu zu erstellende Instanz erstellt werden, evt. mit Angabe einer Sicherungsdatei oder eines SQL-Dumps für die Initialisierung der Datenbank der Instanz (Variable {{konfig|initial_content}}). 

Die Instanz kann dann mit
  C:\>cd ebkus_installation\ebkus
  C:\ebkus_installation\ebkus>python configure.py ''Instanzname''
eingerichtet werden. 

Wenn keine Datei zur Initialisierung angegeben wird, wird eine Datenbank mit den Standardmerkmalskatalogen und einem evt. konfigurierten Straßenkatalog erstellt. Wenn der Instanzname mit {{code|demo}} beginnt, werden zusätzlich Demodaten generiert.

=== Mögliche Probleme ===

* Windows-Dienste werden nicht automatisch installiert: die Konsole muss als Administrator ausgeführt werden.
* Nicht vollständig deinstallierte Dienste: notfalls mit   {{code|sc delete ''Name''}} entfernen. Wenn der Name dann trotzdem noch in der Liste der Dienste auftaucht mit dem Zustand  {{code|Deaktiviert}}, muss ein Neustart gemacht werden.
* Übrig gebliebene Reste in der Registry von früheren Installationen, z.B. des MySQL-Servers. Diese müssen notfalls manuell beseitigt werden.
* Instanz lässt sich nicht mit Sicherungsdatei initialisieren: Die Sicherungsdatei muss von einer Instanz mit demselben Namen stammen.
* Automatischer Download klappt nicht: Falls der Internetzugang  über einen Proxy erfolgt, muss man möglicherweise (ich habs nicht probiert) manuell herunterladen und die Dateien im Downloadverzeichnis ablegen.
* Firefox akzeptiert das von EBKuS gelieferte Zertifikat (wg. doppelter Seriennummer oder so ähnlich): Zertifikate in Firefox löschen über {{pfad5|Einstellungen|Erweitert|Zertifikate|Zertifikate anzeigen|Löschen}}. Die EBKuS-Zertifikate stehen unter dem Namen EFB bzw. unter dem Namen, der in der {{file|ebkus.conf}} als {{konfig|organisation}} (im Abschnitt {{konfig|openssl}}) eingetragen wurde.

=== Tipps ===

* Das {{code|install.py}}-Skript lässt sich wiederholt ausführen. Eine bestehende MySQL- und Apache-Installation wird nicht wiederholt. Vorhandene Instanzdatenbanken bleiben ebenfalls intakt. Evt. neu hinzugekommenen Instanzkonfigurationen werden ausgeführt, d.h. die neue Instanz wird eingerichtet. (Löschen einer Instanz jedoch immer mit {{code|uninstall.py}}!) Alle zu generierenden Dateien werden neu generiert, so dass z.B. auf diese Weise Port-Änderungen oder die Änderung des Servernamens durchgeführt werden können.
* Wenn das {{code|install.py}}-Skript mit der Option {{code|-u}} bzw. {{code|--update}} wiederholt wird, werden zusätzlich alle EBKuS-Dateien aus der Distribution in das Homeverzeichnis kopiert. 
* Hilfe für alle Skripte erhält man mit der Option {{code|--help}} oder kurz {{code|-h}}:
  C:\EBKuS-4.10.1>python install.py --help
  C:\EBKuS-4.10.1>python uninstall.py -h
  C:\ebkus_installation\ebkus>python configure.py -h
  C:\ebkus_installation\ebkus\demo>python dienst.py -h
* Falls Änderungen an generierten Dateien nötig sind (z.B. Apache- oder MySQL-Konfiguration) ist es wenig sinnvoll, diese selbst zu verändern, da man dann nicht mehr die Möglichkeit hat, die Installationsskripte zu verwenden. Besser ist is es, die Templates selber anzupassen. Alle Templates (Vorlagen) für generierte Dateien finden sich im Verzeichnis {{file|templates}} im Homeverzeichnis.