Linux Installation

2011-08-31T17:23:46Z

Atms:

Gültig ab: EBKuS 4.4.1

Die folgende Anleitung habe ich mit '''Ubuntu 10.04.2 LTS''' getestet; vermutlich funktioniert das auch auf anderen Ubuntu bzw. Debian-basierten Gnu/Linux-Distributionen.

Die Installation im folgenden Beispiel erfolgt unter dem User {{code|ebkus}} auf einem Rechner mit dem Namen {{code|ebvm}}. Der User {{code|ebkus}} benötigt Superuserrechte ({{code|sudo}}). Es wird angenommen, dass eine Internetverbindung besteht (zur Installation von Software mit {{code|apt-get}}).

Die Installation erfolgt ausschließlich über die Kommandozeile. Damit funktioniert sie auch auf reinen Servern, die keine GUI haben.

Bitte auch die [[Windows Installation]] beachten, da sind einige betriebssystemunabhängige Punkte ausführlicher dargestellt als hier.

=== Voraussetzungen ===

Folgende Voraussetzungen müssen erfüllt sein, damit EBKuS installiert werden kann:

==== Python ====

Ist auf solche Systemen normalerweise bereits installiert, ansonsten:
ebkus@ebvm:~$ sudo apt-get install python2.6
Es kann auch Python 2.7 sein, wenn das in der Distribution angeboten wird, jedoch '''nicht''' Python 3.0 oder höher.

==== MySQL ====

Bei Ubuntu 10.04 LTS wird MySQL 5.1.XX installiert. Mit der nächsthöheren MySQL-Version 5.5 ist EBKuS noch nicht getestet!

Die Datenbank installieren mit:
ebkus@ebvm:~$ sudo apt-get install mysql-server mysql-common mysql-client
Bei der Installation muss ein Passwort für den Datenbank-User {{code|root}} angegeben werden, das später in die {{file|ebkus.conf}} eingetragen werden muss. Nach einer erfolgreichen Installation kann man sich mit dem Befehl
ebkus@ebvm:~$ mysql -uroot -p''Passwort''
Welcome to the MySQL monitor. Commands end with ; or \g.
...
mysql>
mit der Datenbank verbinden.

Falls der Standardport 3306 für MySQL nicht zur Verfügung steht, muss die Datei {{file|/etc/mysql/my.cnf}} angepasst werden.

==== Python-MySQLdb ====

Den Datenbankadapter für Python-MySQL installieren:
ebkus@ebvm:~$ sudo apt-get install python-mysqldb
Nach erfolgreicher Installation kann man Python aufrufen und MySQLdb importieren:
ebkus@ebvm:~$ python
Python 2.6.5 (r265:79063, Apr 16 2010, 13:09:56)
...
>>> import MySQLdb
>>>

==== Apache 2 ====

Den Webserver installieren:
ebkus@ebvm:~$ sudo apt-get install apache2
Nach der erfolgreichen Installation erhält man mit einem Browser mit der Adresse <nowiki>http://localhost/</nowiki> eine Seite mit '''It works!'''. Oder man installiert z.B. {{code|wget}} und erhält mit der genannten Adresse die entsprechende HTML-Datei {{file|index.html}}:
ebkus@ebvm:~$ sudo apt-get install wget
ebkus@ebvm:~$ wget <nowiki>http://localhost/</nowiki>

Falls der Webserver nicht auf den Standardports 80 und 443 laufen soll, muss die Datei {{file|/etc/apache2/ports.conf}} angepasst werden, ebenso die {{file|ebkus.conf}} (siehe [[Konfiguration]])

Um den Webserver zu konfigurieren, muss das SSL-Modul aktiviert werden, indem zwei symbolische Links wie folgt gesetzt werden:
ebkus@ebvm:~$ cd /etc/apache2/mods-enabled
ebkus@ebvm:/etc/apache2/mods-enabled$ sudo ln -s ../mods-available/ssl.conf ssl.conf
ebkus@ebvm:/etc/apache2/mods-enabled$ sudo ln -s ../mods-available/ssl.load ssl.load
Außerdem muss die von EBKuS generierte Apache-Konfigurationsdatei eingebunden werden:
ebkus@ebvm:~$ cd /etc/apache2/sites-enabled
ebkus@ebvm:/etc/apache2/sites-enabled$ sudo ln -s /home/ebkus/ebkus_installation/ebkus/ebkus_httpd.conf ebkus-ssl
Die Datei {{file|ebkus_httpd.conf}} existiert zu diesem Zeitpunkt noch nicht, sie wird bei der Installation ({{file|install.py}}) und bei jeder Änderung von Instanzen ({{file|configure.py}}) neu generiert. Sie definiert einen Virtual Host für den Webserver, über den alle EBKuS-Instanzen angesprochen werden.

'''Dateirechte:''' Alle Verzeichnisse, die in einem Pfad zu einer Datei stehen, die vom Webserver gelesen werden soll, müssen das Leserecht und das Ausführungsrecht besitzen. Wenn das Installationsverzeichnis wie im Beispiel im Homeverzeichnis eines Benutzers steht, müssen diese Rechte evt. explizit vergeben werden:
ebkus@ebvm:~$ sudo chmod go+rx /home/ebkus
Den vom Installationsskript erzeugten Verzeichnissen und Dateien werden diese Rechte automatisch gegeben.

==== Reportlab ====

Falls keine Internetverbindung besteht, muss [ftp://www.efb-berlin.de/pub/ebkus/ebkus-3.3/linux/ReportLab_1_19.zip diese] Datei bei der Installation im Downloadverzeichnis stehen, ansonsten wird sie bei der Installation automatisch heruntergeladen.

==== EBKuS ====

Die neueste [ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ EBKuS-Software] herunterladen, auspacken und in das Distributionsverzeichnis gehen, z.B.:
ebkus@ebkusvm1:~$ wget ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ebkus-4.4.1-src.zip
ebkus@ebkusvm1:~$ unzip ebkus-4.4.1-src.zip
ebkus@ebkusvm1:~$ cd EBKuS-4.4.1
ebkus@ebkusvm1:~/EBKuS-4.4.1$

=== Installation ===

==== Erstkonfiguration ====

Erstkonfiguration erzeugen:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -c ~/ebkus_installation
Die EBKuS-Konfigurationsdatei {{file|/home/ebkus/ebkus_installation/ebkus/ebkus.conf}} kann nun weiter bearbeitet und für die eigentliche Installation verwendet werden.

==== Systemkonfiguration ====

System-[[Konfiguration]] anpassen, insbesondere:
* Passwort für Datenbank-User {{code|root}} eintragen (Parameter {{konfig|database_admin_password}})
* {{konfig|server_name}}, entweder IP-Nummer oder Name (FQDN)
* Evt. Standardports {{konfig|server_https_port}} und {{konfig|server_http_port}} anpassen
* {{konfig| server_admin}}
* Im Abschnitt {{code|openssl}} Angaben zur Region und Organisation

==== Instanzkonfiguration ====

Instanz-[[Konfiguration]] anpassen:
* {{konfig|instance_name}}, optional {{konfig|instance_title}}
* {{konfig|initial_content}}, falls eine initiale Datenbank vorhanden ist (z.B. aus einer früheren Installation)
* {{konfig|port}}

==== Installation ====

Installation:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py ~/ebkus_installation
Bei der Installation wird man unter Umständen nach dem Passwort des (Linux-)Users gefragt, dasselbe, das man bei einem vorangestellten {{code|sudo}} angeben muss. Damit können die start/stop-Skripte in die Bootsequenz ({{file|/etc/init.d/}}) eingetragen werden

Nach der Installation (und auch nach jeder Umkonfigurierung mit {{file|configure.py}}) muss der Webserver neu gestartet werden:
ebkus@ebvm:~$ sudo service apache2 restart
* Restarting web server apache2 [ OK ]
Ansonsten wird die neu generierte Webserver-Konfiguration in {{file|ebkus_httpd.conf}} nicht wirksam.

==== Migration ====

Falls wie [[Windows_Installation#Migration|hier]] beschrieben eine Menge von bestehenden Instanzen in die neue Installation übernommen werden soll:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -p ~/ebkus_preconfig ~/ebkus_installation
Im Verzeichnis {{file|~/ebkus_preconfig}} muss dann eine gültige {{file|ebkus.conf}} liegen sowie eine Sicherungsdatei für jede Instanz, die in der Konfiguration über den Parameter {{konfig|initial_content}} eingebunden wird.

=== Dienste ===

Im Unterschied zur [[Windows Installation|Windows]] werden bei der Installation und der Konfigurierung keine Dienste gestartet oder gestoppt. Es werden jedoch Skripte in {{file|/etc/init.d}} generiert, mit denen die EBKuS-Server hoch und runtergefahren werden. Beim booten des Systems geschieht dies automatisch, d.h. nach einem Reboot steht EBKuS automatisch zur Verfügung.

Für den Systemadministrator gibt es folgende Skripte, die nach der Installation im Homeverzeichnis stehen:
* {{code|ebkusctl}}: Damit kann jede Instanz einzeln oder auch alle Instanzen gemeinsam hoch- und runtergefahren werden sowie deren Status abgefragt werden. Dieses Skript verwendet intern die generierten Skripte in {{file|/etc/init.d}}.
* {{code|ebkusdump}}: Für jede Instanz einzeln oder für alle zusammen eine Sicherungsdatei erzeugen (verwendet intern {{file|datenbank_sichern.py||}}).
* {{code|ebkusrestore}}: Für jede Instanz einzeln oder für alle zusammen die Datenbank aus eine Sicherungsdatei initialisieren (verwendet intern {{file| datenbank_initialisieren.py||}}).
Z.B.
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl all start
* Starting EBKuS demo [ OK ]
* Starting EBKuS muster_efb [ OK ]
* Starting EBKuS demo_braunschweig [ OK ]
Jedes Skript hat eingebaute Hilfe:
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl --help
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl -h

Linux Installation

2011-08-31T17:22:00Z

Atms:

Gültig ab: EBKuS 4.4.1

Die folgende Anleitung habe ich mit '''Ubuntu 10.04.2 LTS''' getestet; vermutlich funktioniert das auch auf anderen Ubuntu bzw. Debian-basierten Gnu/Linux-Distributionen.

Die Installation im folgenden Beispiel erfolgt unter dem User {{code|ebkus}} auf einem Rechner mit dem Namen {{code|ebvm}}. Der User {{code|ebkus}} benötigt Superuserrechte ({{code|sudo}}). Es wird angenommen, dass eine Internetverbindung besteht (zur Installation von Software mit {{code|apt-get}}).

Die Installation erfolgt ausschließlich über die Kommandozeile. Damit funktioniert sie auch auf reinen Servern, die keine GUI haben.

Bitte auch die [[Windows Installation]] beachten, da sind einige betriebssystemunabhängige Punkte ausführlicher dargestellt als hier.

=== Voraussetzungen ===

Folgende Voraussetzungen müssen erfüllt sein, damit EBKuS installiert werden kann:

==== Python ====

Ist auf solche Systemen normalerweise bereits installiert, ansonsten:
ebkus@ebvm:~$ sudo apt-get install python2.6
Es kann auch Python 2.7 sein, wenn das in der Distribution angeboten wird, jedoch '''nicht''' Python 3.0 oder höher.

==== MySQL ====

Bei Ubuntu 10.04 LTS wird MySQL 5.1.XX installiert. Mit der nächsthöheren MySQL-Version 5.5 ist EBKuS noch nicht getestet!

Die Datenbank installieren mit:
ebkus@ebvm:~$ sudo apt-get install mysql-server mysql-common mysql-client
Bei der Installation muss ein Passwort für den Datenbank-User {{code|root}} angegeben werden, das später in die {{file|ebkus.conf}} eingetragen werden muss. Nach einer erfolgreichen Installation kann man sich mit dem Befehl
ebkus@ebvm:~$ mysql -uroot -p''Passwort''
Welcome to the MySQL monitor. Commands end with ; or \g.
...
mysql>
mit der Datenbank verbinden.

Falls der Standardport 3306 für MySQL nicht zur Verfügung steht, muss die Datei {{file|/etc/mysql/my.cnf}} angepasst werden.

==== Python-MySQLdb ====

Den Datenbankadapter für Python-MySQL installieren:
ebkus@ebvm:~$ sudo apt-get install python-mysqldb
Nach erfolgreicher Installation kann man Python aufrufen und MySQLdb importieren:
ebkus@ebvm:~$ python
Python 2.6.5 (r265:79063, Apr 16 2010, 13:09:56)
...
>>> import MySQLdb
>>>

==== Apache 2 ====

Den Webserver installieren:
ebkus@ebvm:~$ sudo apt-get install apache2
Nach der erfolgreichen Installation erhält man mit einem Browser mit der Adresse <nowiki>http://localhost/</nowiki> eine Seite mit '''It works!'''. Oder man installiert z.B. {{code|wget}} und erhält mit der genannten Adresse die entsprechende HTML-Datei {{file|index.html}}:
ebkus@ebvm:~$ sudo apt-get install wget
ebkus@ebvm:~$ wget <nowiki>http://localhost/</nowiki>

Falls der Webserver nicht auf den Standardports 80 und 443 laufen soll, muss die Datei {{file|/etc/apache2/ports.conf}} angepasst werden, ebenso die {{file|ebkus.conf}} (siehe [[Konfiguration]])

Um den Webserver zu konfigurieren, muss das SSL-Modul aktiviert werden, indem zwei symbolische Links wie folgt gesetzt werden:
ebkus@ebvm:~$ cd /etc/apache2/mods-enabled
ebkus@ebvm:/etc/apache2/mods-enabled$ sudo ln -s ../mods-available/ssl.conf ssl.conf
ebkus@ebvm:/etc/apache2/mods-enabled$ sudo ln -s ../mods-available/ssl.load ssl.load
Außerdem muss die von EBKuS generierte Apache-Konfigurationsdatei eingebunden werden:
ebkus@ebvm:~$ cd /etc/apache2/sites-enabled
ebkus@ebvm:/etc/apache2/sites-enabled$ sudo ln -s /home/ebkus/ebkus_installation/ebkus/ebkus_httpd.conf ebkus-ssl
Die Datei {{file|ebkus_httpd.conf}} existiert zu diesem Zeitpunkt noch nicht, sie wird bei der Installation ({{file|install.py}}) und bei jeder Änderung von Instanzen ({{file|configure.py}}) neu generiert. Sie definiert einen Virtual Host für den Webserver, über den alle EBKuS-Instanzen angesprochen werden.

'''Dateirechte:''' Alle Verzeichnisse, die in einem Pfad zu einer Datei stehen, die vom Webserver gelesen werden soll, müssen das Leserecht und das Ausführungsrecht besitzen. Wenn das Installationsverzeichnis wie im Beispiel im Homeverzeichnis eines Benutzers steht, muss diese Rechte evt. vergeben werden:
ebkus@ebvm:~$ sudo chmod go+rx /home/ebkus
Den vom Installationsskript erzeugten Verzeichnissen und Dateien werden diese Rechte automatisch gegeben.

==== Reportlab ====

Falls keine Internetverbindung besteht, muss [ftp://www.efb-berlin.de/pub/ebkus/ebkus-3.3/linux/ReportLab_1_19.zip diese] Datei bei der Installation im Downloadverzeichnis stehen, ansonsten wird sie bei der Installation automatisch heruntergeladen.

==== EBKuS ====

Die neueste [ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ EBKuS-Software] herunterladen, auspacken und in das Distributionsverzeichnis gehen, z.B.:
ebkus@ebkusvm1:~$ wget ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ebkus-4.4.1-src.zip
ebkus@ebkusvm1:~$ unzip ebkus-4.4.1-src.zip
ebkus@ebkusvm1:~$ cd EBKuS-4.4.1
ebkus@ebkusvm1:~/EBKuS-4.4.1$

=== Installation ===

==== Erstkonfiguration ====

Erstkonfiguration erzeugen:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -c ~/ebkus_installation
Die EBKuS-Konfigurationsdatei {{file|/home/ebkus/ebkus_installation/ebkus/ebkus.conf}} kann nun weiter bearbeitet und für die eigentliche Installation verwendet werden.

==== Systemkonfiguration ====

System-[[Konfiguration]] anpassen, insbesondere:
* Passwort für Datenbank-User {{code|root}} eintragen (Parameter {{konfig|database_admin_password}})
* {{konfig|server_name}}, entweder IP-Nummer oder Name (FQDN)
* Evt. Standardports {{konfig|server_https_port}} und {{konfig|server_http_port}} anpassen
* {{konfig| server_admin}}
* Im Abschnitt {{code|openssl}} Angaben zur Region und Organisation

==== Instanzkonfiguration ====

Instanz-[[Konfiguration]] anpassen:
* {{konfig|instance_name}}, optional {{konfig|instance_title}}
* {{konfig|initial_content}}, falls eine initiale Datenbank vorhanden ist (z.B. aus einer früheren Installation)
* {{konfig|port}}

==== Installation ====

Installation:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py ~/ebkus_installation
Bei der Installation wird man unter Umständen nach dem Passwort des (Linux-)Users gefragt, dasselbe, das man bei einem vorangestellten {{code|sudo}} angeben muss. Damit können die start/stop-Skripte in die Bootsequenz ({{file|/etc/init.d/}}) eingetragen werden

Nach der Installation (und auch nach jeder Umkonfigurierung mit {{file|configure.py}}) muss der Webserver neu gestartet werden:
ebkus@ebvm:~$ sudo service apache2 restart
* Restarting web server apache2 [ OK ]
Ansonsten wird die neu generierte Webserver-Konfiguration in {{file|ebkus_httpd.conf}} nicht wirksam.

==== Migration ====

Falls wie [[Windows_Installation#Migration|hier]] beschrieben eine Menge von bestehenden Instanzen in die neue Installation übernommen werden soll:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -p ~/ebkus_preconfig ~/ebkus_installation
Im Verzeichnis {{file|~/ebkus_preconfig}} muss dann eine gültige {{file|ebkus.conf}} liegen sowie eine Sicherungsdatei für jede Instanz, die in der Konfiguration über den Parameter {{konfig|initial_content}} eingebunden wird.

=== Dienste ===

Im Unterschied zur [[Windows Installation|Windows]] werden bei der Installation und der Konfigurierung keine Dienste gestartet oder gestoppt. Es werden jedoch Skripte in {{file|/etc/init.d}} generiert, mit denen die EBKuS-Server hoch und runtergefahren werden. Beim booten des Systems geschieht dies automatisch, d.h. nach einem Reboot steht EBKuS automatisch zur Verfügung.

Für den Systemadministrator gibt es folgende Skripte, die nach der Installation im Homeverzeichnis stehen:
* {{code|ebkusctl}}: Damit kann jede Instanz einzeln oder auch alle Instanzen gemeinsam hoch- und runtergefahren werden sowie deren Status abgefragt werden. Dieses Skript verwendet intern die generierten Skripte in {{file|/etc/init.d}}.
* {{code|ebkusdump}}: Für jede Instanz einzeln oder für alle zusammen eine Sicherungsdatei erzeugen (verwendet intern {{file|datenbank_sichern.py||}}).
* {{code|ebkusrestore}}: Für jede Instanz einzeln oder für alle zusammen die Datenbank aus eine Sicherungsdatei initialisieren (verwendet intern {{file| datenbank_initialisieren.py||}}).
Z.B.
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl all start
* Starting EBKuS demo [ OK ]
* Starting EBKuS muster_efb [ OK ]
* Starting EBKuS demo_braunschweig [ OK ]
Jedes Skript hat eingebaute Hilfe:
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl --help
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl -h

Linux Installation

2011-08-30T20:02:55Z

Atms:

Gültig ab: EBKuS 4.4.1

Die folgende Anleitung habe ich mit '''Ubuntu 10.04.2 LTS''' getestet; vermutlich funktioniert das auch auf anderen Ubuntu bzw. Debian-basierten Gnu/Linux-Distributionen.

Die Installation im folgenden Beispiel erfolgt unter dem User {{code|ebkus}} auf einem Rechner mit dem Namen {{code|ebvm}}. Der User {{code|ebkus}} benötigt Superuserrechte ({{code|sudo}}). Es wird angenommen, dass eine Internetverbindung besteht (zur Installation von Software mit {{code|apt-get}}).

Die Installation erfolgt ausschließlich über die Kommandozeile. Damit funktioniert sie auch auf reinen Servern, die keine GUI haben.

Bitte auch die [[Windows Installation]] beachten, da sind einige betriebssystemunabhängige Punkte ausführlicher dargestellt als hier.

=== Voraussetzungen ===

Folgende Voraussetzungen müssen erfüllt sein, damit EBKuS installiert werden kann:

==== Python ====

Ist auf solche Systemen normalerweise bereits installiert, ansonsten:
ebkus@ebvm:~$ sudo apt-get install python2.6
Es kann auch Python 2.7 sein, wenn das in der Distribution angeboten wird, jedoch '''nicht''' Python 3.0 oder höher.

==== MySQL ====

Bei Ubuntu 10.04 LTS wird MySQL 5.1.XX installiert. Mit der nächsthöheren MySQL-Version 5.5 ist EBKuS noch nicht getestet!

Die Datenbank installieren mit:
ebkus@ebvm:~$ sudo apt-get install mysql-server mysql-common mysql-client
Bei der Installation muss ein Passwort für den Datenbank-User {{code|root}} angegeben werden, das später in die {{file|ebkus.conf}} eingetragen werden muss. Nach einer erfolgreichen Installation kann man sich mit dem Befehl
ebkus@ebvm:~$ mysql -uroot -p''Passwort''
Welcome to the MySQL monitor. Commands end with ; or \g.
...
mysql>
mit der Datenbank verbinden.

Falls der Standardport 3306 für MySQL nicht zur Verfügung steht, muss die Datei {{file|/etc/mysql/my.cnf}} angepasst werden.

==== Python-MySQLdb ====

Den Datenbankadapter für Python-MySQL installieren:
ebkus@ebvm:~$ sudo apt-get install python-mysqldb
Nach erfolgreicher Installation kann man Python aufrufen und MySQLdb importieren:
ebkus@ebvm:~$ python
Python 2.6.5 (r265:79063, Apr 16 2010, 13:09:56)
...
>>> import MySQLdb
>>>

==== Apache 2 ====

Den Webserver installieren:
ebkus@ebvm:~$ sudo apt-get install apache2
Nach der erfolgreichen Installation erhält man mit einem Browser mit der Adresse <nowiki>http://localhost/</nowiki> eine Seite mit '''It works!'''. Oder man installiert z.B. {{code|wget}} und erhält mit der genannten Adresse die entsprechende HTML-Datei {{file|index.html}}:
ebkus@ebvm:~$ sudo apt-get install wget
ebkus@ebvm:~$ wget <nowiki>http://localhost/</nowiki>

Falls der Webserver nicht auf den Standardports 80 und 443 laufen soll, muss die Datei {{file|/etc/apache2/ports.conf}} angepasst werden, ebenso die {{file|ebkus.conf}} (siehe [[Konfiguration]])

Um den Webserver zu konfigurieren, muss das SSL-Modul aktiviert werden, indem zwei symbolische Links wie folgt gesetzt werden:
ebkus@ebvm:~$ cd /etc/apache2/mods-enabled
ebkus@ebvm:/etc/apache2/mods-enabled$ sudo ln -s ../mods-available/ssl.conf ssl.conf
ebkus@ebvm:/etc/apache2/mods-enabled$ sudo ln -s ../mods-available/ssl.load ssl.load
Außerdem muss die von EBKuS generierte Apache-Konfigurationsdatei eingebunden werden:
ebkus@ebvm:~$ cd /etc/apache2/sites-enabled
ebkus@ebvm:/etc/apache2/sites-enabled$ sudo ln -s /home/ebkus/ebkus_installation/ebkus/ebkus_httpd.conf ebkus-ssl
Die Datei {{file|ebkus_httpd.conf}} existiert zu diesem Zeitpunkt noch nicht, sie wird bei der Installation ({{file|install.py}}) und bei jeder Änderung von Instanzen ({{file|configure.py}}) neu generiert. Sie definiert einen Virtual Host für den Webserver, über den alle EBKuS-Instanzen angesprochen werden.

==== Reportlab ====

Falls keine Internetverbindung besteht, muss [ftp://www.efb-berlin.de/pub/ebkus/ebkus-3.3/linux/ReportLab_1_19.zip diese] Datei bei der Installation im Downloadverzeichnis stehen, ansonsten wird sie bei der Installation automatisch heruntergeladen.

==== EBKuS ====

Die neueste [ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ EBKuS-Software] herunterladen, auspacken und in das Distributionsverzeichnis gehen, z.B.:
ebkus@ebkusvm1:~$ wget ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ebkus-4.4.1-src.zip
ebkus@ebkusvm1:~$ unzip ebkus-4.4.1-src.zip
ebkus@ebkusvm1:~$ cd EBKuS-4.4.1
ebkus@ebkusvm1:~/EBKuS-4.4.1$

=== Installation ===

==== Erstkonfiguration ====

Erstkonfiguration erzeugen:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -c ~/ebkus_installation
Die EBKuS-Konfigurationsdatei {{file|/home/ebkus/ebkus_installation/ebkus/ebkus.conf}} kann nun weiter bearbeitet und für die eigentliche Installation verwendet werden.

==== Systemkonfiguration ====

System-[[Konfiguration]] anpassen, insbesondere:
* Passwort für Datenbank-User {{code|root}} eintragen (Parameter {{konfig|database_admin_password}})
* {{konfig|server_name}}, entweder IP-Nummer oder Name (FQDN)
* Evt. Standardports {{konfig|server_https_port}} und {{konfig|server_http_port}} anpassen
* {{konfig| server_admin}}
* Im Abschnitt {{code|openssl}} Angaben zur Region und Organisation

==== Instanzkonfiguration ====

Instanz-[[Konfiguration]] anpassen:
* {{konfig|instance_name}}, optional {{konfig|instance_title}}
* {{konfig|initial_content}}, falls eine initiale Datenbank vorhanden ist (z.B. aus einer früheren Installation)
* {{konfig|port}}

==== Installation ====

Installation:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py ~/ebkus_installation
Bei der Installation wird man unter Umständen nach dem Passwort des (Linux-)Users gefragt, dasselbe, das man bei einem vorangestellten {{code|sudo}} angeben muss. Damit können die start/stop-Skripte in die Bootsequenz ({{file|/etc/init.d/}}) eingetragen werden

Nach der Installation (und auch nach jeder Umkonfigurierung mit {{file|configure.py}}) muss der Webserver neu gestartet werden:
ebkus@ebvm:~$ sudo service apache2 restart
* Restarting web server apache2 [ OK ]
Ansonsten wird die neu generierte Webserver-Konfiguration in {{file|ebkus_httpd.conf}} nicht wirksam.

==== Migration ====

Falls wie [[Windows_Installation#Migration|hier]] beschrieben eine Menge von bestehenden Instanzen in die neue Installation übernommen werden soll:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -p ~/ebkus_preconfig ~/ebkus_installation
Im Verzeichnis {{file|~/ebkus_preconfig}} muss dann eine gültige {{file|ebkus.conf}} liegen sowie eine Sicherungsdatei für jede Instanz, die in der Konfiguration über den Parameter {{konfig|initial_content}} eingebunden wird.

=== Dienste ===

Im Unterschied zur [[Windows Installation|Windows]] werden bei der Installation und der Konfigurierung keine Dienste gestartet oder gestoppt. Es werden jedoch Skripte in {{file|/etc/init.d}} generiert, mit denen die EBKuS-Server hoch und runtergefahren werden. Beim booten des Systems geschieht dies automatisch, d.h. nach einem Reboot steht EBKuS automatisch zur Verfügung.

Für den Systemadministrator gibt es folgende Skripte, die nach der Installation im Homeverzeichnis stehen:
* {{code|ebkusctl}}: Damit kann jede Instanz einzeln oder auch alle Instanzen gemeinsam hoch- und runtergefahren werden sowie deren Status abgefragt werden. Dieses Skript verwendet intern die generierten Skripte in {{file|/etc/init.d}}.
* {{code|ebkusdump}}: Für jede Instanz einzeln oder für alle zusammen eine Sicherungsdatei erzeugen (verwendet intern {{file|datenbank_sichern.py||}}).
* {{code|ebkusrestore}}: Für jede Instanz einzeln oder für alle zusammen die Datenbank aus eine Sicherungsdatei initialisieren (verwendet intern {{file| datenbank_initialisieren.py||}}).
Z.B.
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl all start
* Starting EBKuS demo [ OK ]
* Starting EBKuS muster_efb [ OK ]
* Starting EBKuS demo_braunschweig [ OK ]
Jedes Skript hat eingebaute Hilfe:
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl --help
ebkus@ebvm:~/ebkus_installation/ebkus$ ebkusctl -h

2011-06-30T19:31:46Z

Atms:

Gültig ab: EBKuS 4.4.1

=== Voraussetzungen ===

Die folgende Anleitung habe ich mit '''Ubuntu 10.04.2 LTS''' getestet; vermutlich funktioniert das auch auf anderen Ubuntu bzw. Debian-basierten Gnu/Linux-Distributionen.

Die Installation im folgenden Beispiel erfolgt unter dem User {{code|ebkus}} auf einem Rechner mit dem Namen {{code|ebvm}}. Der User {{code|ebkus}} benötigt Superuserrechte ({{code|sudo}}). Es wird angenommen, dass eine Internetverbindung besteht (zur Installation von Software mit {{code|apt-get}}).

Die Installation erfolgt ausschließlich über die Kommandozeile. Damit funktioniert sie auch auf reinen Servern, die kein GUI haben.

Folgende Voraussetzungen müssen erfüllt sein, damit EBKuS installiert werden kann:

==== Python ====

Ist auf solche Systemen normalerweise bereits installiert, ansonsten:
ebkus@ebvm:~$ sudo apt-get install python2.6
Es kann auch Python 2.7 sein, wenn das in der Distribution angeboten wird, jedoch '''nicht''' Python 3.0 oder höher.

==== MySQL ====

Bei Ubuntu 10.04 LTS wird MySQL 5.1.XX installiert. Mit der nächsthöheren MySQL-Version 5.5 ist EBKuS noch nicht getestet!

Die Datenbank installieren mit:
ebkus@ebvm:~$ sudo apt-get install mysql-server mysql-common mysql-client
Bei der Installation muss ein Passwort für den Datenbank-User {{code|root}} angegeben werden, das später in die {{file|ebkus.conf}} eingetragen werden muss. Nach einer erfolgreichen Installation kann man sich mit dem Befehl
ebkus@ebvm:~$ mysql -uroot -p''Passwort''
Welcome to the MySQL monitor. Commands end with ; or \g.
...
mysql>
mit der Datenbank verbinden.

Falls der Standardport 3306 für MySQL nicht zur Verfügung steht, muss die Datei {{file|/etc/mysql/my.cnf}} angepasst werden.

==== MySQLdb ====

Den Datenbankadapter für Python-MySQL installieren:
ebkus@ebvm:~$ sudo apt-get install python-mysqldb
Nach erfolgreicher Installation kann man Python aufrufen und MySQLdb importieren:
ebkus@ebvm:~$ python
Python 2.6.5 (r265:79063, Apr 16 2010, 13:09:56)
...
>>> import MySQLdb
>>>

==== Apache 2 ====

Den Webserver installieren:
ebkus@ebvm:~$ sudo apt-get install apache2
Nach der erfolgreichen Installation erhält man mit einem Browser mit der Adresse <nowiki>http://localhost/</nowiki> eine Seite mit '''It works!'''. Oder man installiert z.B. {{code|wget}} und erhält mit der genannten Adresse die entsprechende HTML-Datei {{file|index.html}}:
ebkus@ebvm:~$ sudo apt-get install wget
ebkus@ebvm:~$ wget http://localhost/

Falls der Webserver nicht auf den Standardports 80 und 443 laufen soll, muss die Datei {{file|/etc/apache2/ports.conf}} angepasst werden, ebenso die {{file|ebkus.conf}} (siehe [[Konfiguration]])

==== Reportlab ====

Falls keine Internetverbindung besteht, muss
[ftp://www.efb-berlin.de/pub/ebkus/ebkus-3.3/linux/ReportLab_1_19.zip diese] Datei bei der Installation im Downloadverzeichnis stehen, ansonsten wird sie bei der Installation automatisch heruntergeladen.

==== EBKuS ====

Die neueste [ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ EBKuS-Software] herunterladen, auspacken und in das Distributionsverzeichnis gehen, z.B.:
ebkus@ebkusvm1:~$ wget ftp://www.efb-berlin.de/pub/ebkus/ebkus-4.4/ebkus-4.4.1-rc1-src.zip
ebkus@ebkusvm1:~$ unzip ebkus-4.4.1-rc1-src.zip
ebkus@ebkusvm1:~$ cd EBKuS-4.4.1
ebkus@ebkusvm1:~/EBKuS-4.4.1$

=== Installation ===

Erstkonfiguration erzeugen:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -c ~/ebkus_installation

System-[[Konfiguration]] anpassen, insbesondere:
* Passwort für Datenbank-User {{code|root}} eintragen (Parameter {{konfig|database_admin_password}})
* {{konfig|server_name}}, entweder IP-Nummer oder Name (FQDN)
* Evt. Standardports {{konfig|server_https_port}} und {{konfig|server_http_port}} anpassen
* {{konfig| server_admin}}
* Im Abschnitt {{code|openssl}} Angaben zur Region und Organisation

Instanz-[[Konfiguration]] anpassen:
* {{konfig|instance_name}}, optional {{konfig|instance_title}}
* {{konfig|initial_content}}, falls eine initiale Datenbank vorhanden ist (z.B. aus einer früheren Installation)
* {{konfig|port}}

Installation:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py ~/ebkus_installation
Falls wie in [[Windows_Installation#Migration]] beschrieben eine Menge von bestehenden Instanzen übernommen werden soll:
ebkus@ebkusvm1:~/EBKuS-4.4.1$ ./install.py -p ~/ebkus_preconfig ~/ebkus_installation
Bei der Installation wird man unter Umständen nach dem Passwort des (Linux-)Users gefragt, dasselbe, das man bei einem vorangestellten {{code|sudo}} angeben muss. Damit werden die start/stop Skript in die Bootsequenz ({{file|/etc/init.d/}}) eingetragen.

Schritte:

#`Installationsverzeichnis`_ einrichten, z.B. {{code|/home/user/ebinst}}:
mkdir /home/user/ebinst
#In das `Distributionsverzeichnis`_ gehen (z.B. {{code|/home/user/ebkus-cd/ebkus-3.3}}; man könnte hier auch direkt von der CD arbeiten):
cd /home/user/ebkus-cd/ebkus-3.3
#EBKuS-Konfiguration erzeugen:
python install.py --config /home/user/ebinst
#Erzeugte Konfigurationsdatei {{code|/home/user/ebinst/ebkus/ebkus.conf}}anpassen (siehe `Konfiguration`_).
#EBKuS und alle in der Konfigurationsdatei definierten Instanzen installieren und konfigurieren:
python install.py /home/user/ebinst
Für jede in der Konfiguration definierten Instanz gibt es dann ein `Instanzverzeichnis`_:

<blockquote>{{code|/home/user/ebinst/ebkus/}}''Instanzname''

</blockquote>
Die Meldungen des Installationsskriptes stehen auch in der Datei {{code|/home/user/ebinst/install.log}}.

#(als {{code|root}}) Die in Schritt 5. erzeugte Datei {{code|/home/user/ebinst/ebkus/ebkus_httpd.conf}} in die Apache-Konfigurationsdatei (bei SuSE z.B. /etc/httpd/httpd.conf) inkludieren, z.B. indem Sie dort am Ende die folgende Zeile eintragen:
Include /home/user/ebinst/ebkus/ebkus_httpd.conf
#(als {{code|root}}) Den Apache-Webserver neustarten, damit die modifizierte Konfiguration berücksichtigt wird, z.B. bei SuSE:
rcapache restart
#Eine konfigurierte EBKuS-Instanz testen, z.B. die Instanz demo:
cd /home/user/ebinst/ebkus/demo
./start.py --console
Der gestartete Server gibt Meldungen auf die Konsole aus.

#Über einen Browser mit der Instanz {{code|demo}} arbeiten (anstatt {{code|demo}} auch mit jeder anderen in der `Konfiguration`_definierten Instanz):
https://localhost/ebkus/demo/cgi/do/login
Die Login-Maske kann auch über eine vorgeschaltete Eingangsseite erreicht werden, die für jede Instanz generiert wird:

https://localhost/ebkus/demo/index.html
Diese Seite kann mit einem HTML-Editor gemäß den lokalen Bedürfnissen erweitert oder verändert werden. Die zu editierende Datei ist im `Instanzverzeichnis`_ unter {{code|htdocs/index.html}} zu finden.

Als Administrator anmelden: Benutzer {{code|Admin}}, Passwort {{code|Admin}}. Als angemeldeter Administrator können Sie weitere Benutzer anlegen.

Die Instanzen {{code|demo}} bzw. {{code|demo_berlin}} enthalten bereits Beispieldaten, mit denen Sie experimentieren können. Sie können sich also gleich als Bearbeiter bzw. als Verwaltungskraft anmelden, z.B. Benutzer {{code|test}}, Passwort {{code|test}} bzw. Benutzer {{code|verw}}, Passwort {{code|verw}}.

Falls Sie in der Konfiguration den Parameter ''server_name'' mit einer in Ihrem Netzwerk gültigen IP-Adresse oder einem gültigen Namen belegt haben, können Sie auch von anderen Rechnern im Netzwerk auf eine EBKuS-Instanz zugreifen, z.B.:

https://192.168.1.92/ebkus/demo/index.html https://192.168.1.92/ebkus/demo/cgi/do/login
#(als {{code|root}}) Die Instanz in die Bootsequenz des Servers aufnehmen, so dass beim Hochfahren des Rechners der EBKuS-Server für die Instanz automatisch gestartet wird:
cd /home/user/ebinst/ebkus/demo cp ebkus_demo /etc/init.d
Die Links für die Run-Level manuell setzen oder, z.B. bei SuSE, den Run-Level-Editor verwenden.

#In einer Produktionsinstanz die Anwendung einrichten, siehe Einrichtung der Anwendung im Handbuch.

- Apache richtig löschen, so dass frische Konfig kommt:

- sudo dpkg --purge --force-remove-reinstreq apache2.2-common

So geht richtiges uninstall mit Konfiguration:
apt-get remove ––purge *paketname*

- download mit wget auf dem ubuntu server

== Apache Konfiguration ==

cd /etc/apache2/mods-enabled
sudo ln -s ../mods-available/ssl.conf ssl.conf
sudo ln -s ../mods-available/ssl.load ssl.load

cd /etc/apache2/sites-enabled
sudo ln -s /home/ebkus/ebkus_installation/ebkus/ebkus_httpd.conf ebkus-ssl
http://ebkus.org/wiki/Linux_Installation#MySQL
http://ebkus.org/wiki/Linux_Installation#Apache_2

Linux Installation

2011-06-30T17:31:41Z

Atms:

Linux Installation

2011-06-30T17:28:42Z

Atms:

2011-06-27T13:43:11Z

Atms:

== Systemvariablen ==

=== <nowiki>[ebkus]</nowiki> ===

{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
|- align="left" style="background-color:aliceblue;"
! Parameter
! Standardwert
! Bedeutung
|-
|{{konfig|database_admin_host}}
|{{code|localhost}}
|Name oder IP-Nummer des Rechners, auf dem MySQL läuft. Muss angegeben werden, wenn das nicht der lokale Rechner ist.

|-
|{{konfig|database_admin_user}}
|{{code|root}}
|MySQL-Benutzer mit Administratorrechten

|-
|{{konfig|database_admin_password}}
|{{code|}}
|Dessen Passwort. Wenn hier ``ASK`` steht, wird das Passwort bei Bedarf interaktiv abgefragt.

|-
|{{konfig|download_dir}}
|{{konfig|install_dir}}/download
|Downloadverzeichnis. Dort steht die zu installierende Software, die im Bedarfsfall heruntergeladen wird.

|-
|{{konfig|ebkus_home}}
|{{konfig|install_dir}}/ebkus
|Homeverzeichnis

|-
|{{konfig|install_dir}}
|{{code|}}
|Installationsverzeichnis

|-
|{{konfig|mysql_dir}}
|{{code|}}
|Verzeichnis, in dem die MySQL-Programme mysql, mysqldump, etc. stehen. Muss angegeben werden, wenn MySQL-Programme nicht im Pfad stehen.

|-
|{{konfig|python_executable}}
|{{code|sys.executable}}
|Vollständiger Pfad des Python-Executable
|}

=== <nowiki>[apache]</nowiki> ===

{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
|- align="left" style="background-color:aliceblue;"
! Parameter
! Standardwert
! Bedeutung
|-
|{{konfig|apache_log_dir}}
|{{konfig|ebkus_home}}/log
|Verzeichnis, in dem der Apache-Webserver Log-Dateien anlegt
|-
|{{konfig|server_admin}}
|{{code|admin@localhost}}
|Email-Adresse des Serveradministrators, die auf evt. Fehlerseiten des Servers erscheint.

|-
|{{konfig|server_name}}
|{{code|localhost}}
|Name oder IP-Nummer des Rechners, auf dem der Apache-Webserver läuft.
**Muss** explizit eingetragen werden, sonst kann EBKuS nur auf dem lokalen Rechner verwendet werden!

|-
|{{konfig|ssl_certificate_file}}
|{{konfig|ebkus_home}}/ebkus_ssl_certificates/ebkusserver.cert
|Vollständiger Pfad der SSL-Zertifikat-Datei

|-
|{{konfig|ssl_certificate_key_file}}
|{{konfig|ebkus_home}}/ebkus_ssl_certificates/ebkusserver.key
|Vollständiger Pfad der SSL-Schlüssel-Datei
|}

=== <nowiki>[openssl]</nowiki> ===

{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
|- align="left" style="background-color:aliceblue;"
! Parameter
! Standardwert
! Bedeutung
|-
|{{konfig|openssl_executable}}
|{{code|openssl}}
|Falls openssl nicht im Pfad steht, muss der hier der vollständige Pfad zum Executable stehen

|-
|{{konfig|output_password}}
|{{code|polo}}
|Wird zur automatischen Zertifikatgenerierung benötigt

|-
|{{konfig|staat}}
|{{code|DE}}
|Erscheint im SSL-Zertifikat

|-
|{{konfig|land}}
|{{code|Berlin}}
|Erscheint im SSL-Zertifikat

|-
|{{konfig|ort}}
|{{code|Berlin}}
|Erscheint im SSL-Zertifikat
|-
|{{konfig|organisation}}
|{{code|EFB}}
|Erscheint im SSL-Zertifikat

|-
|{{konfig|organisationseinheit}}
|{{code|EFB}}
|Erscheint im SSL-Zertifikat

|}

=== <nowiki>[</nowiki>''Instanz''<nowiki>]</nowiki> ===

{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
|- align="left" style="background-color:aliceblue;"
! Parameter
! Standardwert
! Bedeutung

|-
|{{konfig|berliner_version}}
|{{code|false}}
|

|-
|{{konfig|database_host}}
|{{code|localhost}}
|

|-
|{{konfig|database_name}}
|{{konfig|instance_name}}
|

|-
|{{konfig|database_password}}
|{{konfig|instance_name}}
|

|-
|{{konfig|database_type}}
|{{code|MySQLdb}}
|

|-
|{{konfig|database_user}}
|{{konfig|instance_name}}
|

|-
|{{konfig|gemeindeschluessel_von_plz}}
|{{code|}}
|Definiert die Teilmenge der amtlichen Gemeindeschlüssel für die Bundesstatistik.
 
In der Bundesstatistik soll der amtliche Gemeindeschlüssel für den Wohnort des Klienten eingetragen werden, wenn der Wohnort des Klienten außerhalb des Kreises der Beratungsstelle liegt. Um die Menge der Daten zu begrenzen, kann hier über die Anfangsziffern der Postleitzahl eine Teilmenge definiert werden. Wenn mehrere Ziffernfolgen angegeben werden, müssen diese mit <code>;</code> getrennt werden. Im Normalfall brauchen Sie den voreingestellten Wert nicht zu ändern. Beispiele: <ul> <li>Alle Gemeindeschlüssel verwenden, außer die Postleitzahl der Gemeinde beginnt mit '9': <pre> 0;1;2;3;4;5;6;7;8 </pre> </li> <li>Große Teile Niedersachsens: <pre> 29;30;31;37;38 </pre> </li> <li>Nördliches Niedersachsen und Schleswig Holstein: <pre> 2 </pre> </li> <li>Berlin und Umgebung: <pre> 10;12;13;14;15;16 </pre> </li> <li>Bleibt die Variable leer, werden alle Gemeindeschlüssel verwendet. </li> </ul> Wenn es bei der Erkennung von Gemeindeschluesseln zu vielen Fehlern kommt, beispielsweise wegen unterschiedlicher Schreibweisen von Orten, kann man selber eine Datei <code>EBKUS_HOME/sql/gemeindeschluessel.csv</code> erstellen, bestehend aus einer Tabelle mit den Spalten <code>plz, ort ags</code>. Als Vorlage kann die Datei <code>EBKUS_HOME/sql/gemeindeschluessel_cache.csv</code> dienen, die automatisch erzeugt wird, wenn die Konfigurationsvariable <code>gemeindeschluessel_von_plz</code> einen Wert hat.
|-
|{{konfig|host}}
|{{code|localhost}}
|

|-
|{{konfig|initial_content}}
|{{code|}}
|

|-
|{{konfig|instance_home}}
|{{code|%(ebkus_home)s/%(instance_name)s}}
|

|-
|{{konfig|instance_name}}
|{{code|}}
|

|-
|{{konfig|keine_bundesstatistik}}
|{{code|false}}
|Fall kann ohne Bundestatistik abgeschlossen werden.

Alles andere sollte trotzdem noch funktionieren.
|-
|{{konfig|log_file}}
|{{konfig|instance_home}}/ {{konfig|instance_name}}.log
|

|-
|{{konfig|log_level}}
|{{code|INFO}}
|

|-
|{{konfig|port}}
|{{code|}}
|
|}

==== Konfiguration für externe Anwendungen ====

Die folgenden Konfigurationsvariablen bewirken, dass auf der
Klientenkarte ein Kasten mit vier Buttons erscheint, die in einem
neuen Tab/Fenster eine URL aufrufen, die Felder des aktuellen
(letzten) Falles bzw. des angemeldeten Mitarbeiters als
Bestandteile haben kann:
# Kein Kasten, wenn diese Variable keinen Wert hat.
extern_fieldset_label: Externe Anwendung
# Position auf der Klientenkarte
extern_fieldset_position: 6
# Maximal vier Buttons, für jeden eine Bezeichnung und eine Url.
# Ein Button kommt nur zustande, wenn sowohl Label als auch Url
# einen Wert haben.
extern_button1_label: GoogleWeb
extern_button1_url: <nowiki>http://www.google.com/search?q=$$fall_id$$_$$fall_akte__ort$$</nowiki>
extern_button2_label: GoogleMaps
extern_button2_url: http://www.google.com/maps?q=$$mitarbeiter_na$$
extern_button3_label: GoogleImages
extern_button3_url: http://www.google.com/images?q=$$fall_akte__ort$$
extern_button4_label: GoogleNews
extern_button4_url: http://www.google.com/news?q=$$fall_fn$$

Urls können Abschnitte der folgenden Form enthalten:
{{code|$$<fall oder mitarbeiter>_<feld>$$}}
Der ganze Abschnitt wird durch den Wert von {{code|<feld>}} ersetzt,
wobei entweder im Fall-Objekt oder im Mitarbeiter-Objekt
nachgeschlagen wird.
Beispiele:
{{code|$$fall_id$$}}, {{code|$$mitarbeiter_na$$}}, {{code|$$fall_akte__ort$$}}

Im Beispiel oben werden als externe Anwendungen verschiedene Google-Dienst aufgerufen, wobei als Parameter Daten aus dem aktuellen Fall übergeben werden.
(Das Beispiel ist nicht sinnvoll und dient nur der Illustration des Mechanismus.)

{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
|- align="left" style="background-color:aliceblue;"
! Parameter
! Standardwert
! Bedeutung
|-
|{{konfig|extern_fieldset_label}}
|{{code|}}
|Bezeichnung für den Kasten mit den Buttons für die externen Anwendungen

|-
|{{konfig|extern_fieldset_position}}
|{{code|2}}
|Position auf der Klientenkarte
|-
|{{konfig|extern_buttonX_label}}
|{{code|}}
|Name der externen Anwendung

|-
|{{konfig|extern_buttonX_url}}
|{{code|}}
|URL der externen Anwendung

|}

X kann 1,2,3 oder 4 sein.

== Fachvariablen ==

=== <nowiki>[</nowiki>''Instanz''<nowiki>]</nowiki> ===

{|border="1" cellspacing="0" cellpadding="8" style="background-color:snow;" width="100%"
|- align="left" style="background-color:aliceblue;"
! Parameter
! Standardwert
! Bedeutung
|-
|{{konfig|admin_email}}
|{{code|Keine Angabe}}
|Email-Adresse des Anwendungsadministrators.

Wird in Fehlermeldungen genannt.
|-
|{{konfig|admin_name}}
|{{code|Keine Angabe}}
|Name des Anwendungsadministrators.

Wird in Fehlermeldungen genannt.
|-
|{{konfig|admin_tel}}
|{{code|Keine Angabe}}
|Telefonnummer des Anwendungsadministrators.

Wird in Fehlermeldungen genannt.
|-
|{{konfig|anmeldungsdaten_obligatorisch}}
|{{code|false}}
|Falls <code>true</code> werden die Anmeldungsdaten obligatorisch im Aufnahmeformular erhoben anstatt optional in einer getrennten Maske.

Die entsprechenden Pflichfelder sind dabei auszufüllen. Eine spätere Bearbeitung der Anmeldungsdaten erfolgt wie bisher in einer eigenständigen Maske (analog der späteren Bearbeitung einer Leistung).
|-
|{{konfig|beratungskontakte}}
|{{code|false}}
|Falls <code>true</code> können in der Klientenakte einzelne Beratungskontakte eingetragen werden. Die Summen werden in die Bundesstatistik und in die Fachstatistik als Vorgabe übernommen.
|-
|{{konfig|beratungskontakte_bs}}
|{{code|false}}
|Falls <code>true</code> treten Anpassungen speziell für Braunschweig in Kraft.

Die Variable <code>beratungskontakte</code> muss ebenfalls auf <code>true</code> stehen.
|-
|{{konfig|fachstatistik_akte_}} {{konfig|diskrepanz_nicht_zulassen}}
|{{code|false}}
|Falls <code>true</code> werden Diskrepanzen zwischen Fachstatistik und Akte nicht zugelassen.

Die entsprechenden Items in der Fachstatistik zeigen die Werte aus der Akte und sind nicht modifizierbar. Eine Diskrepanz kann so gar nicht entstehen. Allerdings muss bei Änderungen in der Akte die Fachstatistik neu abgespeichert werden, damit die Änderungen übernommen und für die Statistik wirksam werden. Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.
|-
|{{konfig|fallunabhaengige_aktivitaeten_bs}}
|{{code|false}}
|Falls <code>true</code> können fallunabhängige Aktivitäten eingetragen und ausgewertet werden. Speziell für Braunschweig.
|-
|{{konfig|instance_title}}
|{{konfig|instance_name}}
|Langname für die Instanz.

Erscheint bei der Anmeldung und in der Statuszeile.
|-
|{{konfig|loeschfrist}}
|{{code|36}}
|Löschfrist in Monaten.

Akten, die älter sind, können vom Administrator gelöscht werden.
|-
|{{konfig|meldung_vom_admin}}
|{{code|}}
|Inhalt wird als Meldung vom Administrator unübersehbar auf jeder EBKuS-Seite über der Statuszeile ausgegeben.

Damit kann der Administrator Meldungen an alle aktiven EBKuS-Nutzer ausgeben, z.B. um einen Ausfall von EBKuS wegen Wartungsarbeiten anzukündigen.
|-
|{{konfig|neumeldungen_nach_region}}
|{{code|}}
|Definiert eine Tabelle "Neumeldungen nach Region" unter "Neumelde- und Abschlusszahlen".
 
Die Regionen, für die in der Tabelle die Neumeldungen ausgezählt werden sollen, müssen unter {{pfad4|Hauptmenü|Statistikabfrage|Teilmenge|Neu}} als Teilmengendefinitionen eingeführt werden. Der Namen der gewünschten Definitionen werden durch <code>;</code> getrennt aufgeführt. Beispiel: <ul> <li> <pre> Gifhorn und Samtgemeinde Meinersen; Braunschweig 38120 und 38112 </pre> </li> </ul> "Gifhorn und Samtgemeinde Meinersen" ist eine Teilmengendefinition mit der Definition: <code>( ort = 'Gifhorn' ODER samtgemeinde = 'Meinersen' )</code>. "Braunschweig 38120 und 38112" ist eine Teilmengendefinition mit der Definition: <code>( ort = 'Braunschweig' UND plz = '38112' oder '38120' )</code>. 
|-
|{{konfig|session_time}}
|{{code|120}}
|Länge einer Session in Minuten.

Nach dieser Zeit wird ein Benutzer automatisch abgemeldet, wenn er keine Eingaben mehr macht.
|-
|{{konfig|sql_abfrage}}
|{{code|false}}
|Falls <code>true</code> steht die Maske zum Absetzen von SQL-Abfragen vom Administrationsmenü aus zur Verfügung.

|-
|{{konfig|strassenkatalog}}
|{{code|}}
|Falls diese Variable nicht leer ist, wird bei der Adresseingabe der Straßenkatalog verwendet.

Der eigentliche Wert der Variable spielt nur bei der Erstinstallation der Instanz eine Rolle. Eine Instanz ohne Straßenkatalog kann auch später noch für die Verwendung mit Straßenkatalog eingerichtet werden, indem der Straßenkatalog über {{pfad2|Administratorhauptmenü|Straßenkatalog importieren}} importiert wird und der Variable {{konfig|strassenkatalog}} ein beliebiger Wert zugewiesen wird, beispielsweise der Ortsname.
|-
|{{konfig|strassenkatalog_vollstaendig}}
|{{code|false}}
|Falls <code>true</code> wird angenommen, dass der Straßenkatalog Einträge für jede einzelne Hausnummer enthält.

Ansonsten wird angenommen, dass lediglich Einträge für ganze Straßen bzw. für bestimmte Intervalle von Hausnummern vorhanden sind.
|-
|{{konfig|strassensuche}}
|{{code|}}
|Bestimmt die Anzeige von Zusatzinformationen aus dem Straßenkatalog bei der Darstellung und Eingabe von Adressen.

Zulässige Werte sind: <code>ort bezirk ortsteil samtgemeinde</code>. Beispiele: <ul> <li>In Berlin gibt es nur einen Ort im Straßenkatalog, nämlich 'Berlin'. Das Feld <code>ort</code> ist daher nicht nötig. Ortsteil und Samtgemeinde haben im Straßenkatalog keine Werte, Bezirk allerdings schon. Der sinnvolle Wert für Berlin ist also <pre> bezirk </pre> </li> <li>In Gifhorn gibt es mehrere Orte im Straßenkatalog. Sowohl Ortsteile und Samtgemeinden spielen eine Rolle und sind im Straßenkatalog erfasst, Bezirke jedoch nicht. Der sinnvolle Wert hier ist also <pre> ort ortsteil samtgemeinde </pre> </li> <li>Wenn es nur einen Ort gibt und weder Bezirke, Ortsteile oder Samtgemeinden im Straßenkatalog erfasst sind, sollte die Variable leer bleiben. </ul> Irrelevant, wenn kein Straßenkatalog verwendet wird.
|-
|{{konfig|warnung_bei_fachstatistik_}} {{konfig|akte_diskrepanz}}
|{{code|false}}
|Falls <code>true</code> wird beim Speichern der Fachstatistik auf eine Diskrepanz zwischen Akte und Fachstatistik hingewiesen, falls vorhanden.

Wenn man bei dem dann zur Verfügung stehendem Item "Diskrepanz zur Akte zulassen" ein Häkchen setzt, kann man trotzdem speichern. Betroffen sind nur die Items 'Familienstatus', 'Empfohlen von' und 'Erbrachte Leistungen in der Fachstatistik', deren Werte im Normalfall aus der Akte vorbelegt werden.
|-
|{{konfig|wiederaufnahmefrist}}
|{{code|1}}
|Anzahl der Monate, innerhalb derer ein abgeschlossener Fall wiederaufgenommen werden kann ("z.d.A. rückgängig").

Danach muss ein neuer Fall angelegt werden.
|-
|{{konfig|wohnt_nicht_ausserhalb}}
|{{code|}}
|Definiert die Teilmenge der Adressen, die im Sinne der Bundesstatistik in die Zuständigkeit der Beratungsstelle fallen.

Aufgrund der hier angegebenen Kriterien wird entschieden, ob der Klient in der Bundesstatistik als ausserhalb des Kreises der Beratungsstelle wohnend angegeben wird. Als mögliche Kriterien kommen in Frage: <code>plz,ort,ortsteil,samtgemeinde,bezirk,plraum</code>. Die Kriterien <code>ortsteil,samtgemeinde,bezirk</code> sind nur sinnvoll, wenn ein Straßenkatalog verwendet wird und dieser auch entsprechende Angaben enthält. Die Kriterien werden wie folgt in der angegebenen Reihenfolge abgearbeitet: <ul> <li>Wenn die Klientenadresse keinen Wert für das Kriterium aufweist, wird zum nächsten Kriterium übergegangen. </li> <li>Falls die Klientenadresse einen Wert hat und im Kriterium genannt wird, wohnt er nicht außerhalb. Ist der Wert im Kriterium nicht genannt, wohnt er außerhalb. In beiden Fällen werden die weiteren Kriterien nicht mehr betrachtet. </li> <li>Falls aufgrund fehlender Werte (oder fehlender Kriterien) kein Kriterium angewendet werden konnte, wird standardmäßig angenommen, dass der Klient nicht außerhalb wohnt. </li> </ul> Beispiele: <ul> <li> <pre> bezirk: Friedrichshain-Kreuzberg; ort: Berlin </pre> In Berlin enthalten alle mit dem Straßenkatalog abgeglichene Adressen einen Wert für den Bezirk. Da jede Beratungsstelle genau für einen Bezirk zuständig ist, kann auf dieser Basis entschieden werden. Falls eine Adresse nicht mit dem Straßenkatalog abgeglichen wurde, kann der Ort als Kriterium herangezogen werden, da in diesem Fall für Bezirk keine Angaben vorliegen. </li> <li> Falls kein Straßenkatalog verwendet wird, kann nur der Ort, die Postleitzahl oder evt. der Planungsraum (falls solche definiert sind und routinemäßig mit den Klientenadressen zusammen erfasst werden) als Kriterium verwendet werden, z.B. (fiktiv!): <pre> plz: 12345;23456;34567 </pre> Adressen mit diesen Postleitzahlen werden als nicht außerhalb wohnend betrachtet, alle anderen als außerhalb. Falls die Klientenadresse keine 5-stellige PLZ enthält, gilt der Wert als fehlend. Ungenauigkeiten werden in Kauf genommen, da die Region der Zuständigkeit nicht immer exakt mit den Regionen der Postleitzahlen übereinstimmt. </li> <li> <pre> samtgemeinde: Name1;Name2;Name3; plz: 12345;23456 </pre> Analog zum Berliner Beispiel würde hier auch zunächst das Kriterium Samtgemeinde versucht, das aber nur nach einem Abgleich mit dem Straßenkatalog bekannt ist. Für die nicht abgeglichenen Adressen wird dann die Postleitzahl herangezogen. In seltenen Fällen kann das zu Fehlern führen, da die Bereiche der Postleitzahlen manchmal nicht mit den Bereichen der Zuständigkeit exakt übereinstimmen. </li> </ul> Falls das Ergebnis "wohnt außerhalb" ist, wird automatisch ein entsprechender Eintrag in die Bundesstatistik vorgenommen, der beim Ausfüllen oben im Kasten "Falldaten" angezeigt wird. Wenn möglich wird der amtliche Gemeindeschlüssel eingetragen. Wenn dieser nicht gefunden wird, wird Postleitzahl und Wohnort angegeben. Syntax wie in den Beispielen. Rund um die Trenner <code>;</code> und <code>:</code> dürfen Leerzeichen stehen. Es können auch mehrere Zeilen verwendet werden. Unter (Berater-) "Hauptmenü -- Statistik -- Teilmenge -- Neu -- Neue Bedingung" finden Sie für jedes Kriterium die Menge der möglichen Werte. Zur Testen gibt es unter "Aministratorhauptmenü -- Bundesstatistik -- Exportieren" einen neuen Punkt "Adressen außerhalb prüfen". Sie können dort in einer Tabelle sehen, welche Adressen als außerhalb klassifiziert werden.
|}