Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- software:controller:vzlogger:installation_en [2017/03/22 03:55] – von /software/controller/vzlogger/installation_cpp-version verschoben jau
+++ software:controller:vzlogger:installation_en [2023/03/13 07:57] (aktuell) – Externe Bearbeitung 127.0.0.1
@@ Zeile 1: / Zeile 1: @@
-====== vzlogger Installation ======
+====== vzlogger Installation (en) ======
 === Repository ===
 Our repository: https://github.com/volkszaehler/vzlogger\\
-Actually vzlogger and some of the libraries are only provided by sourcecode. They have to be compiled before use.
+Actually vzlogger and sometimes the libraries are only provided by sourcecode. They have to be compiled before use.
 Select a working directory your user has writing permissions. For example the home directory:
 <code>
 cd ~
 </code>
+The most experience is collected from Debian and other Distributions close (Ubuntu, Raspian). The following guide is based on Debian "Bullseye" in April of 2022. Specific instructions for older Versions can be found in the history of this site.
 ===== Prerequisites for compiling vzlogger =====
@@ Zeile 15: / Zeile 16: @@
 === Tools ===
-  * git (package: git-core)
+  * git
   * cmake
   * pkg-config
@@ Zeile 31: / Zeile 32: @@
   * libltdl >=0.8.0 (for OMS)
   * libleptonica-dev (for OCR)
+  * libmosquitto-dev (for MQTT)
+  * libunistring-dev (due to problem Ubuntu 18.04)
 === Debian packages ===
-On Debian-Jessie based distributios, most of these dependencies can easily be installed with:
+On Debian based distributions, most of these dependencies can easily be installed with:
 (as root, consider running "apt-get update" first)
-<code>sudo apt-get install build-essential git-core cmake pkg-config subversion libcurl4-openssl-dev libgnutls28-dev libsasl2-dev uuid-dev libtool libssl-dev libgcrypt20-dev libmicrohttpd-dev libltdl-dev libjson-c-dev libleptonica-dev dh-autoreconf</code>
+<code>sudo apt-get install build-essential git cmake pkg-config subversion libcurl4-openssl-dev libgnutls28-dev libsasl2-dev uuid-dev libtool libssl-dev libgcrypt20-dev libmicrohttpd-dev libltdl-dev libjson-c-dev libleptonica-dev libmosquitto-dev libunistring-dev dh-autoreconf</code>
-For Debian Wheezy:
-<code>sudo apt-get install build-essential git-core cmake pkg-config subversion libcurl3-dev libgnutls-dev libsasl2-dev uuid-dev libtool libmicrohttpd-dev libcurl4-openssl-dev libssl-dev libltdl-dev libleptonica-dev dh-autoreconf</code>
 ===== Build by script =====
@@ Zeile 50: / Zeile 49: @@
 The script supports also build of one single module. See the comments in the script for details.
+=== Daemon ===
+At this point a daemon-service should be prepared to run vzlogger in backgroung. Details [[/software/controller/vzlogger/installation_en#systemd_start_script|down below]].
 === Update ===
+If a update is necessary follow these steps:
 <code>
-sudo systemctl stop vzlogger  #only works after creating the systemd start script, see below
+sudo systemctl stop vzlogger
 cd vzlogger
 git pull
 ./install.sh vzlogger
-sudo systemctl start vzlogger #only works after creating the systemd start script, see below
+sudo systemctl start vzlogger
 </code>
-===== Build by hand =====
+The based SML Library may (before) updated by:
-In cases the script does not fit the conditions.
-=== Building libjson ===
-The best case is building libjson from source, which is simple too:
 <code>
-sudo apt-get install dh-autoreconf
+cd vzlogger/libs/libsml
-git clone -b json-c-0.12 https://github.com/json-c/json-c
+git pull
-cd json-c
+cd ../..
-sh autogen.sh
+./install.sh libsml
-./configure
-make
-sudo make install
 </code>
-Go back to your starting directory: <code>cd ..</code>
+===== Build by hand =====
+In cases the script does not fit the conditions.
+<note warning>Only for experienced users! Follow [[/software/controller/vzlogger/installation_en#build_by_script|build by script]] instead.</note>
 === Building libsml ===
+Debian provides a paket libsml-dev, but it's not well maintained and too old for our needs.
 <code>
 git clone https://github.com/volkszaehler/libsml.git
@@ Zeile 102: / Zeile 100: @@
 mkdir build
 cd build
-cmake ..
+cmake -DBUILD_TEST=off ..
 make
 sudo make install
@@ Zeile 108: / Zeile 106: @@
 Go back to your starting directory: <code>cd ../..</code>
+== Build as Debian-paket ==
+The vzlogger repository contains code to build a "clean" paket for Debian.
+<code>
+git clone https://github.com/volkszaehler/vzlogger.git
+cd vzlogger
+apt build-dep ./
+apt install devscripts
+debuild
+</code>
 === Building OMS ===
@@ Zeile 122: / Zeile 130: @@
 Go back to your starting directory: <code>cd ..</code>
-=== Update vzlogger ===
+=== Daemon ===
+At this point a daemon-service should be prepared to run vzlogger in backgroung. Details [[/software/controller/vzlogger/installation_en#systemd_start_script|down below]].
+=== Update vzlogger ===
+If a update is necessary follow these steps:
 <code>
-sudo systemctl stop vzlogger #only works after creating the systemd start script, see below
 cd vzlogger
 git pull
 cd build
-cmake ..
+cmake -DBUILD_TEST=off ..
 make
+sudo systemctl stop vzlogger
 sudo make install
-cd ../..
+sudo systemctl start vzlogger
-sudo systemctl start vzlogger #only works after creating the systemd start script, see below
 </code>
-if you are having trouble building with libsml, instead of just "cmake .", use:
-<code>
-cmake .. -DSML_HOME=/path/to/libsml
-</code>
-a debian package can be generated using:
-<code>
-cpack -G DEB
-</code>
-=== Cross compiling ===
-<code>
-cmake -DCMAKE_TOOLCHAIN_FILE=/path/to/toolchainfile /path/to/vzlogger_sources
-</code>
 ====== Systemd start script ======
+Systemd is used to install and execute services in background (daemon).
-The installscript asks you for installing the systemd unit file for you. If your computer uses systemd (Debian-Jessie) you may answer yes.
+The installscript asks you for installing the systemd unit file for you. If your computer uses systemd (since Debian-Jessie) you may answer yes.
-If you want to copy and edit it by yourself you find a template under: [[https://github.com/volkszaehler/vzlogger/blob/master/etc/vzlogger.service|./etc/vzlogger.service]] Destination of the file for Debian: /etc/systemd/system/vzlogger.system
+If you want to copy and edit it by yourself you find a template under: [[https://github.com/volkszaehler/vzlogger/blob/master/etc/vzlogger.service|./etc/vzlogger.service]]
+<code>sudo cp ./etc/vzlogger.service /etc/systemd/system/vzlogger.service</code>
 <note important>
@@ Zeile 177: / Zeile 172: @@
 sudo systemctl enable vzlogger
 </code>
+====== Run vzlogger with different user ======
+=== Elevated privileges for vzlogger binary ===
+<code>
+sudo setcap 'cap_sys_nice=eip' /usr/local/bin/vzlogger
+</code>
+<note>On Raspberry might still be problems with configuration of GPIOs. Earlier export in ''/etc/rc.local'' solves the problem.</note>
+=== Add Daemon-User ===
+Add a user without home-directory and generate password.
+<code>
+sudo useradd -M vzlogger
+sudo passwd vzlogger
+</code>
+Add the user to the follwing groups:
+<code>
+sudo usermod -aG gpio vzlogger
+sudo usermod -aG dialout vzlogger
+sudo usermod -aG staff vzlogger
+</code>
+For the logfile generate a sub-directory with adequate rights.
+<code>
+sudo mkdir /var/log/vzlogger
+sudo chgrp staff /var/log/vzlogger
+sudo chmod g+w /var/log/vzlogger
+</code>
+=== adapt vzlogger.conf ===
+The new location oft logfile has to be configured accordingly. ''/etc/vzlogger.conf'':
+<code>
+"log" : "/var/log/vzlogger/vzlogger.log",
+</code>
+=== adapt Systemd startscript ===
+Last change is to promote the new user in systemd startscript (see chapter above).
+Under [Service] add the following line:
+<code>
+User=vzlogger
+</code>
+Systemd need to be restartet to activate the change:
+<code>
+sudo systemctl daemon-reload
+</code>
+=== Use-sase===
+This adaption is of particular interest in combination with meter-protocol "exec". Vzlogger doesn't have to be recompiled and the actions started by "exec" run with lower user-privilges.
+====== Special hints ======
+=== debian package ===
+a debian package can be generated using:
+<code>
+cpack -G DEB
+</code>
+=== Cross compiling ===
+<code>
+cmake -DCMAKE_TOOLCHAIN_FILE=/path/to/toolchainfile /path/to/vzlogger_sources
+</code>