====== Installation ======
===== Systemvoraussetzungen =====
  * PHP 7.3 oder neuer
  * MySQL 8.0

==== bekannte Installationen ====
^ Hardware      ^ Betriebssystem                  ^ PHP     ^ Datenbank        ^
| Raspberry PI  | Raspbian GNU/Linux 10 (buster)  | 7.3.31  | MariaDB 10.3.34  |

===== Variablen / Pfadangaben =====
Diese Anleitung verwendet Variablen zur Bestimmung der Verzeichnisse. Die Verzeichnisse sind abhängig vom individuellen System und Wünschen

^ Variable    ^ Wert             ^
| $X2_HOME    | /var/www/html/x2 |
| $APACHE_DIR | /var/www/html    |

===== Benötigte Pakete =====
  * graphviz
  * php-ssh2
  * php-phpseclib
  * libphp-phpmailer

<code>
apt install graphviz php-ssh2 php-phpseclib ibphp-phpmailer
</code>

===== GraphViz =====
GraphViz wird zur Erstellung der Graph-Elemente von X2 verwendet. Dazu muss das Paket für PHP installiert werden

  - pear installieren, falls nicht vorhanden<code>
wget http://pear.php.net/go-pear.phar
php go-pear.phar
</code>
  - Das PHP-Modul für GraphViz installieren<code>
sudo pear install Image_GraphViz
</code>
  - in der Datei ''/etc/php/7.3/apache2/php.ini'' muss ggf. der include-Pfad angpasst werden<code>
include_path = ".:/usr/share/pear:/usr/share/php"
</code>
  - Apache neu starten

===== Datenbank =====
  - Erstellen einer Datenbank<code>create database x2;</code>
  - Erstellen eines Benutzers<code>create user x2 identified by 'x2';</code>
  - Vergeben der Rechte an den neuen Benutzer<code>grant all privileges on x2.* to x2;</code>
  - Einstellungen in der DB laden<code>flush privileges;</code>

===== X2 =====
  - Laden der Quellen der X2 Software<code>
cd $X2_HOME
git clone git@github.com:michdip/x2.git
</code>
  - Erstellen von Arbeitsverzeichnissen<code>
mkdir -p $X2_HOME/log
mkdir -p $X2_HOME/tmp
mkdir -p $X2_HOME/templates/templates_c
mkdir -p $X2_HOME/templates/cache
</code>
  - Sollte das Verzeichnis ''$X2_HOME'' nicht dem User gehören, mit dem der Apache ausgeführt wird, so müssen die Verzeichnisse für diesen zum Schreiben frei gegeben werden<code>
chmod 777 $X2_HOME/log
chmod 777 $X2_HOME/tmp
chmod 777 $X2_HOME/templates/templates_c
chmod 777 $X2_HOME/templates/cache
</code>
  - Konfiguration von
    - ''$X2_HOME/conf.d/base.conf''
    - ''$X2_HOME/conf.d/databases.conf''
    - ''$X2_HOME/conf.d/x2_host.conf''  :!: local muss definiert sein
    - ''$X2_HOME/conf.d/mail.conf''
    - ''$X2_HOME/database/execute.sh''

===== Smarty =====
Smarty wird zur Erstellung der HTML-Ausgabe verwendet. 

  - Laden der Quellen aus dem Git von Smarty<code>
cd $APACHE_DIR
git clone https://github.com/smarty-php/smarty.git
</code>
  - Smarty mit dem X2 verlinken<code>
cd $X2_HOME/lib
ln -s $APACHE_DIR/smarty/libs smarty
</code>

===== X2 Setup =====
  - Einen SSH-Key für das X2 erstellen<code>
$ cd $X2_HOME/conf.d
$ ssh-keygen -b 1024 -t rsa
Generating public/private rsa key pair.
Enter file in which to save the key (/home/pi/.ssh/id_rsa): $X2_HOME/conf.d/id_rsa
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in $X2_HOME/conf.d/id_rsa.
Your public key has been saved in $X2_HOME/conf.d/id_rsa.pub.
The key fingerprint is:
SHA256:QxrATJPO0xR/rtu0cLKLeL8PwZDuEYmDzHOAvBMRn6Q pi@raspberrypi
The key's randomart image is:
+---[RSA 1024]----+
|.++=+...         |
|.=+o=+.+         |
| EB=+o* o .      |
| o o+o.B o       |
|  .  .+ S .      |
|     . . +       |
|      . = o      |
|     ... X .     |
|    ....*++      |
+----[SHA256]-----+
</code>
  - Die Verbindung zu local herstellen<code>
ssh -i ./id_rsa <user>@<host>
</code>
  - Erstellen der Datenbanktabellen<code>
cd $X2_HOME/database
./createDatabase.sh
</code>
  - Import der Datei ''$X2_HOME/database/x2_system.json''
  - Die Gruppe ''X2 System'' hat als Variable ''$X2_HOME'' definiert. Diese muss angepasst werden
  - Alle Templates in der Gruppe ''X2 System'' müssen aktiviert werden
  - Festlegen des ''getLog''-Template
    - In der Gruppe ''X2 System'' befindet sich ein Template mit dem Namen ''getLogs''. Die ID dieses Template muss in folgendes Statement eingegeben werden und an die DB gesendet werden<code>
insert into SEQUENCE (SEQ_NAME, SEQ_VALUE)
values ( 'X2_MASHINE_ROOM_getLogs', <ID des Template>);
</code>
  - Erstellen der crontab<code>
0-59 * * * * cd $X2_HOME && ./x2Deamon.watchdoc.sh
1    0 * * * kill -USR1 `cat $X2_HOME/x2Deamon.pid`
</code>