Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- software:middleware:installation [2019/03/25 11:57] – --static-dir zu middleware.json jau
+++ software:middleware:installation [2022/12/14 15:08] – [PPM als Server (empfohlene Methode)] important note zu Proxies grimaldi
@@ Zeile 5: / Zeile 5: @@
 ===== Voraussetzungen =====
-  * PHP 7.1 (nicht verfügbar in Raspbian Stretch!)
+  * PHP 7.3 (z.B. debian ab Buster (10))
   * Doctrine 2.5
-  * MySQL, MariaDB, PostgreSQL oder SQLite + PDO Treiber
+  * MySQL, MariaDB + PDO Treiber
   * APC (optional, aber empfohlen)
-  * Apache mod_rewrite (optional)
+  * Apache, nginx (optional)
-Es eigenen sich hier Debian oder Ubuntu, sowie für den Raspberry Pi: Raspbian oder Raspbian Light.("Buster"-Version, oder "Stretch" mit PHP Update)\\
+Es eignen sich hier Debian oder Ubuntu, sowie für den Raspberry Pi: Raspbian oder Raspbian Light.("Bullseye"-Version mit PHP 7.4)\\
 Die Abhängigkeiten lassen sich schnell mit folgendem Befehl installieren:
-<code>sudo apt-get install git-core php7.1-cli php7.1-mysql php-apcu mysql-server mysql-client php7.1-xml php-mbstring ca-certificates
+<code>sudo apt-get install git php-cli php-mysql php-apcu mariadb-server mariadb-client php-xml php-mbstring php7.4-opcache php-common ca-certificates zip unzip php-zip apt-transport-https php-curl
 </code>
-bzw. für PostgreSQL
-<code>apt-get install git-core php7.1-cli php7.1-pgsql php-apcu postgresql-8.4</code>
 Für die manuelle Installation wird zudem "curl" benötigt.
@@ Zeile 25: / Zeile 23: @@
-===== Install-Skript (empfohlene Installationsmethode) =====
+===== Install-Skript (empfohlene Methode) =====
 <code>
 wget https://raw.github.com/volkszaehler/volkszaehler.org/master/bin/install.sh
@@ Zeile 177: / Zeile 175: @@
 Das Script fragt, was es wohin installieren soll.
-==== Webserver per PPM (empfohlene Methode)====
+===== Webserver einrichten =====
-Der PPM-Webserver auf Basis von PHP läuft wesentlich Performanter als Apache2 und ist gerade auf schwacher Hardware wie RaspberryPi zu empfehlen.
+Im Folgenden sind 3 mögliche Serverkonfigurationen beschrieben. Für Kompatibiltät mit alten Scripts und Konfigurationen empfehlen wir bei PPM zusätzlich einen Proxy einzurichten.
+==== PPM als Server (empfohlene Methode) ====
+Der PPM-Webserver auf Basis von PHP läuft wesentlich Performanter als Apache2 und ist gerade auf schwacher Hardware wie RaspberryPi zu empfehlen. In Standardkonfiguration bedient er Anfragen auf Port 8080.
   - Systemd Service einrichten ''sudo nano /etc/systemd/system/middleware.service''<code>
 [Unit]
 Description=Volkszaehler.org Middleware
-After=syslog.target network.target
+After=syslog.target network.target mysql.service
 Requires=
 [Service]
-ExecStart=/usr/bin/php /var/www/volkszaehler.org/vendor/bin/ppm start -c /var/www/volkszaehler.org/etc/middleware.json -cgi-path=/usr/bin/php
+ExecStart=/usr/bin/php /var/www/volkszaehler.org/vendor/bin/ppm start -c /var/www/volkszaehler.org/etc/middleware.json --cgi-path=/usr/bin/php
 ExecReload=/bin/kill -HUP $MAINPID
 StandardOutput=journal
@@ Zeile 196: / Zeile 197: @@
   - Server Konfiguration anpassen
     - ''nano ~/volkszaehler.org/etc/middleware.json''
-    - ändern: ''"port": 80,''
     - ändern: ''"static-directory": "/var/www/volkszaehler.org/htdocs",''
   - Middleware Weiterleitung ''url'' anpassen ''nano ~/volkszaehler.org/htdocs/js/options.js'' <code>
@@ Zeile 205: / Zeile 205: @@
   - Systemd Service starten ''sudo systemctl start middleware''
-==== Alternative: Apache installieren (unter Debian "Jessie" und "Stretch") ====
+<note important>Wird kein Proxy installiert, wie in den nächsten Sektionen empfohlen, gibt es den Pfad http://localhost/middleware.php nicht, der in vielen Beispielkonfigurationen auf dieser Webseite verwendet wird! Stattdessen muss http://localhost/ verwendet werden.</note>
-  * Pakete installieren ''sudo apt-get install apache2 libapache2-mod-php7.1''
+==== Apache als Proxy (empfohlene Methode) ====
+Dazu Apache auf die Weiterleitung zum PPM reduzieren.
+  - Module aktivieren<code>
+sudo a2enmod proxy
+sudo a2enmod proxy_http
+sudo a2enmod rewrite</code>
+  - Rewrite-Proxy aktivieren, ''nano ~/volkszaehler.org/htdocs/.htaccess''. Die Kommentarzeichen vor den Zeilen entfernen:<code>
+<IfModule mod_proxy.c>
+        RewriteEngine On
+        RewriteRule ^middleware(.php)?(/.*)? http://localhost:8080/$2 [P]
+        RewriteRule ^api(/.*)$ http://localhost:8080/$1 [P]
+        RewriteRule (.*) http://localhost:8080/$1 [P]
+</IfModule>
+</code>
+  - Default VirtualHost bearbeiten: ''sudo nano /etc/apache2/sites-enabled/000-default.conf''. Dort ''< DocumentRoot >'' suchen und ändern: <code>
+        DocumentRoot /var/www/volkszaehler.org/htdocs/
+</code>
+  - Apache Config bearbeiten um Rewrite in .htaccess zu erlauben: ''sudo nano /etc/apache2/apache2.conf'' In der Datei den Abschnitt suchen: <code>
+<Directory /var/www/>
+        Options Indexes FollowSymLinks
+        AllowOverride None
+        Require all granted
+</Directory>
+</code>''AllowOverride None'' in ''AllowOverride All AuthConfig'' ändern.\\
+  - Dann den Apache nur noch neu starten ''sudo systemctl restart apache2''
+==== Alternativ: nginx als Proxy ====
+Nginx ist ein schlanker Webserver/Proxy dessen Konfiguration sehr zentral erfolgt, was der Performance zu gute kommt. Er ist als Proxy für den Betrieb eines Volkszählers nicht zwingend nötig (PPM kann das gut alleine), bietet aber Abwärtskompatibilität für bestehende Scripte und Anwendungen.
+<code>
+sudo apt install nginx
+sudo rm /etc/nginx/sites-enabled/default
+sudo nano /etc/nginx/sites-available/volkszaehler
+</code>
+In diese wird eingefügt:
+<code>
+# Volkszaehler
+include /etc/nginx/proxy_params;
+server {
+  listen 80;
+  listen [::]:80;
+  server_name volkszaehler.org;
+  location / {
+    proxy_pass http://127.0.0.1:8080;
+    include /etc/nginx/proxy_params;
+  }
+  location /middleware {
+    rewrite ^/middleware(.php)?(/.*)? $2;
+    proxy_pass http://127.0.0.1:8080/;
+  }
+  location /api {
+    rewrite ^/api(/.*)? $1;
+    proxy_pass http://127.0.0.1:8080/;
+  }
+  location /frontend {
+    rewrite ^/frontend/(.*) $1;
+    proxy_pass http://127.0.0.1:8080/;
+  }
+# Konfigurationsbeispiel für eigene PHP-Scripte,
+# von nginx unter http://127.0.0.1/addapp/ bereitgestellt, lokal unter /var/www/html/ abgelegt.
+#
+#  location /addapp/ {
+#    alias /var/www/html/;
+#    index index.nginx-debian.html;
+#
+#    location ~ \.php {
+#      include snippets/fastcgi-php.conf;
+#      fastcgi_param SCRIPT_FILENAME $request_filename;
+#      fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
+#    }
+#  }
+}
+</code>
+<note>Möchte man eigene PHP-Scripte neben Volkszähler bereit stellen ist das das Paket php-fpm nötig.
+Installieren mit ''sudo apt-get install php-fpm'' und darauf achten das in der nginx-Konfiguration bei ''/var/run/php/php7.3-fpm.sock'' auf die korrekte, vorhandene Datei verwiesen wird.</note>
+Damit der nginx die Config lädt:
+<code>
+sudo ln -s /etc/nginx/sites-available/volkszaehler /etc/nginx/sites-enabled/volkszaehler
+</code>
+Dann nur noch Starten und in Bootprozess einbinden:
+<code>
+sudo systemctl start nginx
+sudo systemctl enable nginx
+</code>
+==== Alternativ: Apache als Server (unter Debian "Stretch") ====
+<note>Möchte man von PPM auf Apache als Server umstellen sind auch die Änderungen an der Middleware-Konfiguration für PPM zurück zu nehmen: ''url: 'api' ''</note>
+  * Pakete installieren ''sudo apt-get install apache2 libapache2-mod-php''
   * mod_rewrite aktivieren: ''sudo a2enmod rewrite''
   * Default VirtualHost bearbeiten: ''sudo nano /etc/apache2/sites-enabled/000-default.conf''
@@ Zeile 229: / Zeile 324: @@
 Sollte es zu einem PHP Fehler beim Anlegen der Datenbank kommen versucht mal Doctrine per Hand zu Installieren.
-===== Manuelle Installation =====
+==== Alternativ: nginx als Server ====
+<note>Möchte man von PPM auf nginx als Server umstellen sind auch die Änderungen an der Middleware-Konfiguration für PPM zurück zu nehmen: ''url: 'api' ''.</note>
-=== Download der volkszaehler.org Skripte ===
-Download der Skripte aus dem git Repository:
-<code>
-git clone git://github.com/volkszaehler/volkszaehler.org.git ~/volkszaehler.org
-sudo ln -sf ~/volkszaehler.org /var/www/volkszaehler.org
-sudo chown -R www-data /var/www/volkszaehler.org
-</code>
-=== Apache konfigurieren ===
-  * mod_rewrite aktivieren:
-<code>
-sudo a2enmod rewrite
-</code>
-  * Default VirtualHost bearbeiten:
-<code>
-/etc/apache2/sites-enabled/000-default:
-    DocumentRoot /var/www/volkszaehler.org/htdocs/
-</code>
-  * unter <Directory /var/www/>:
-<code>
-AllowOverride FileInfo Limit Options Indexes Authconfig
-</code>
-=== Alternativ: nginx konfigurieren ===
 <code>
 server {
@@ Zeile 272: / Zeile 341: @@
         location ~ \.php {
                 include snippets/fastcgi-php.conf;
-        #       # With php5-cgi alone:
+        #       # With php7-cgi alone:
         #       fastcgi_pass 127.0.0.1:9000;
-                # With php5-fpm:
+                # With php7-fpm:
-                fastcgi_pass unix:/var/run/php5-fpm.sock;
+                fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
         }
 }
 </code>
+<note>Darauf achten das in der nginx-Konfiguration bei ''/var/run/php/php7.3-fpm.sock'' auf die korrekte, vorhandene Datei verwiesen wird.</note>
-Wichtig ist dass in der config in der Zeile "location ~ \.php {" kein $-Zeichen hinter dem PHP steht. Siehe [[http://volkszaehler.org/pipermail/volkszaehler-dev/2011-June/000925.html|Mail Archiv]]
+Wichtig ist dass in der config in der Zeile "location ~ \.php {" kein $-Zeichen hinter dem PHP steht. Siehe [[https://lists.volkszaehler.org/pipermail/volkszaehler-dev/2011-June/000925.html|Mail Archiv]]
+==== Alternativ: Lighttpd als Server ====
+Notwendige Rewrite-Regeln:
+<code>
+    url.rewrite-if-not-file = (
+        "^/(?:middleware|api)(/.*)?" => "/middleware.php$1",
+	"^/frontend/(.*)" => "$1"
+    )
+</code>
+===== Manuelle Installation =====
+=== Download der volkszaehler.org Skripte ===
+Download der Skripte aus dem git Repository:
+<code>
+git clone git://github.com/volkszaehler/volkszaehler.org.git ~/volkszaehler.org
+sudo ln -sf ~/volkszaehler.org /var/www/volkszaehler.org
+sudo chown -R www-data /var/www/volkszaehler.org
+</code>
 === Installation der benötigten Module ===
@@ Zeile 304: / Zeile 393: @@
 <code>
 cd /var/www/volkszaehler.org/etc/
-cp volkszaehler.conf.template.php volkszaehler.conf.php
+cp config.dist.yaml config.yaml
-edit volkszaehler.conf.php:
+</code>
-    $config['db']['host']               = 'localhost';
+edit config.yaml:
-    $config['db']['user']               = 'vz';
+<code>
-    $config['db']['password']           = '<shhh!>';
+db:
-    $config['db']['dbname']             = 'volkszaehler';
+  host: 127.0.0.1
+  port: 3306
+  user: vz
+  password: demo
+  dbname: volkszaehler
 </code>
@@ Zeile 315: / Zeile 408: @@
 === Datenbank konfigurieren ===
-  * Datenbank-User anlegen:
+  * Datenbank anlegen:
+<code>
+mysql:
+    CREATE DATABASE `volkszaehler`;
+oder phpmyadmin:
+    Home -> "Datenbank anlegen", Name: "volkszaehler" -> "Anlegen"
+</code>
+  * Datenbank-User anlegen:
 <code>
-phpmyadmin:
+mysql:
+    GRANT ALL ON volkszaehler.* to 'vz_admin'@'localhost' IDENTIFIED BY '<shhhh!>' WITH GRANT OPTION;
+    CREATE USER 'vz'@'localhost' IDENTIFIED BY '<shhhh!>';
+    GRANT USAGE ON volkszaehler.* TO 'vz'@'localhost';
+    GRANT SELECT, UPDATE, INSERT ON volkszaehler.* TO 'vz'@'localhost';
+oder phpmyadmin:
+    Home -> "Rechte" -> "Neuen Benutzer hinzufügen"
+        Benutzername: vz_admin
+        Host: localhost
+        Passwort: <shhh!>
+        Vollzugriff (Grant All) auf DB volkszaehler erlauben.
+        -> ok
     Home -> "Rechte" -> "Neuen Benutzer hinzufügen"
         Benutzername: vz
@@ Zeile 325: / Zeile 438: @@
         keine globalen Rechte vergeben!
         -> ok
-oder:
-    CREATE USER 'vz'@'localhost' IDENTIFIED BY '<shhhh!>';
 </code>
-  * Datenbank anlegen:
+ * Tabellen anlegen:
-<code>
-phpmyadmin
-    Home -> "Datenbank anlegen", Name: "volkszaehler" -> "Anlegen"
-oder:
-    CREATE DATABASE `volkszaehler`;
-</code>
-  * Tabellen anlegen:
 <code>
 # cd /var/www/volkszaehler.org/
@@ Zeile 378: / Zeile 481: @@
 mysqladmin reload -p
 </code>
+=== Webserver ===
+Wie bereits [[/software/middleware/installation#webserver_einrichten|weiter oben]] beschrieben.
 ====== Aktualisierung der Middleware einschließlich des Frontends ======
-Nachdem Volkszähler im Zuge der Installation eine Kopie des git Repositories erstellt, kann die Installation auch aus diesem Repository aktualisiert werden.
+Wenn nur die ''./etc/config.yaml'' angepasst kann wieder das [[software:middleware:installation#install-skript_empfohlene_methode|Installationsskript]] von oben verwendet werden. Da die Datenbank vermutlich nicht angetastet werden soll, die entsprechenden Fragen einfach verneinen.
-Eine Beschreibung findet sich im Kapitel zu [[/howto/git]].
+Nachdem Volkszähler im Zuge der Installation eine Kopie des git Repositories erstellt, kann die Installation aber auch aus diesem Repository aktualisiert werden. Eine Beschreibung findet sich im Kapitel zu [[/howto/git]]. Beim Image ist dies der notwendige Weg weil da auch andere Dateien editiert wurden.
 ====== phpMyAdmin installieren ======
+<note>Statt phpMyAdmin empfehlen wir derzeit einen lokalen Client wie z.B. [[https://www.heidisql.com|HeidiSQL]]</note>
 <note important>Für Vollzugriff auf die Volkszählerdatenbank über phpMyAdmin haben wir den User ''vz-admin''. Standardpasswort: ''secure''</note>
 MySQL-Superuser ist: ''root'' und das Standardpasswort: ''raspberry''\\