Added note about cgroup2 protection
[ampy.git] / README.rst
index fd1f1c201c2ca3148e9e947bf0dc0f43d1a46166..9f37c36383a3827c9fd55dfcf91a3ded3678a7e4 100644 (file)
@@ -11,7 +11,7 @@ It is designed for self-hosting, without any third party analysing when you're h
 Hardware
 ========
 
-You need a ampmeter sensor that outputs an audio signal.
+You need a ammeter sensor that outputs an audio signal.
 
 It has been tested with `this YHDC sensor`_.
 
@@ -45,6 +45,7 @@ Ampy requires permission to use the sound card. It's recommanded to create a ded
 
    addgroup --system ampy  # create a dedicated group
    adduser --system --ingroup ampy --home /var/lib/ampy --disabled-password --disabled-login ampy
+   chmod g+ws /var/lib/ampy/  # group can write, sticky group
    adduser ampy audio  # ampy can use audio
    adduser www-data ampy  # httpd in group ampy
 
@@ -84,7 +85,7 @@ Configuration
 Select the alsa audio input
 ---------------------------
 
-Run ``device.py`` to find out which entry you should use.
+Run ``device.py`` to select which entry you want to use.
 
 Then adjust DEVICE in run.py
 
@@ -115,6 +116,10 @@ Calibration
 
 You'll need to adjust VOLUME_CONSTANT in run.py so that you get the correct voltage value.
 
+Starting and stoping a powerfull apliance you know the consuptium of, should give you a good start.
+
+Later on, you can adjust the value based on your legal counter. See bellow.
+
 Autostart
 ---------
 
@@ -149,10 +154,9 @@ Then add something like that in your apache configuration file::
 Counter initialization
 ----------------------
 
-If you have a regular electric meter::
+Point your browser to counterset.php.
 
-   echo "123456" > /var/lib/ampy/counter
-   chown ampy: /var/lib/ampy/counter
+You should do that from time to time. It will show you how off the system is. You can then adjust your VOLUME_CONSTANT in run.py.
 
 
 Copyright
@@ -188,3 +192,6 @@ Notes to cleanup (ignore that)
     watch -n 0.5 rrdtool graphv - '-s' '1546280606' 'DEF:watts=/var/lib/rrdcached/db/power.rrd:watts:AVERAGE' 'VDEF:avg=watts,AVERAGE' 'VDEF:last=watts,LAST' 'PRINT:avg:%lf' 'PRINT:last:%lf'
     Alors que ├ža si:
     watch -n 0.5 rrdtool lastupdate --daemon /var/run/rrdcached.sock /var/lib/rrdcached/db/power.rrd
+
+    If you want to run in a cgroup2 protected container, you need to add:
+    lxc.cgroup2.devices.allow = c 116:* rwm