From 2f7a74ead4047da18b1fb5cc4b97f11921772d89 Mon Sep 17 00:00:00 2001
From: nobody43 <15267739+nobody43@users.noreply.github.com>
Date: Thu, 2 Mar 2023 15:16:18 +0000
Subject: [PATCH] Update README.md
---
README.md | 55 ++++++++++++++++++++++++++++---------------------------
1 file changed, 28 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index 2cac9e1..80f19fc 100644
--- a/README.md
+++ b/README.md
@@ -10,24 +10,21 @@ CPU and disk temperature monitoring scripts for zabbix. Also support voltage and
- Does not spin idle drives
- RAID passthrough (manual)
-![Temperature graph](https://github.com/nobodysu/mini-IPMI/blob/master/screenshots/mini-IPMI-graph.png?raw=true)
+![Temperature graph](https://github.com/nobody43/mini-IPMI/blob/master/screenshots/mini-IPMI-graph.png?raw=true)
-[More screenshots.](https://github.com/nobodysu/zabbix-mini-IPMI/tree/master/screenshots)
-
-### STANDBY drives
-UPD: not relevant anymore. Just use custom 0.8.0.5+.
+[More screenshots.](https://github.com/nobody43/zabbix-mini-IPMI/tree/master/screenshots)
### Choosing OHMR version
-NEW: [Update](https://github.com/openhardwaremonitor/openhardwaremonitor/pull/1115#issuecomment-616230088) your OHMR version!
-#### [0.3.2.0](https://github.com/openhardwaremonitor/openhardwaremonitor/issues/230#issue-102662845)
-Version for Windows XP.
-#### [0.8.0.5](https://github.com/openhardwaremonitor/openhardwaremonitor/pull/1115#issuecomment-462141642)
+Only custom param-capable versions are supported on Windows 7+:
+#### [0.9.6.0](https://github.com/openhardwaremonitor/openhardwaremonitor/pull/1115#issuecomment-1189362017)
#### [0.9.2.0](https://github.com/openhardwaremonitor/openhardwaremonitor/pull/1115#issuecomment-616230088)
-Only custom param-capable versions are supported on Windows 7+.
+#### [0.8.0.5](https://github.com/openhardwaremonitor/openhardwaremonitor/pull/1115#issuecomment-462141642)
+Version for Windows XP:
+#### [0.3.2.0](https://github.com/openhardwaremonitor/openhardwaremonitor/issues/230#issue-102662845)
## Installation
As prerequisites you need `python3`, `lm-sensors`, `smartmontools`, `sudo` and `zabbix-sender` packages. For testing `zabbix-get` is also required.
-Take a look at scripts first lines and provide paths if needed. If you have custom RAID configuration, also provide that by hand. Import `Template_mini-IPMI_v2.xml` in zabbix web interface.
+Take a look at scripts first lines and provide paths if needed. If you have custom RAID configuration, also provide that manually. Import `Template_mini-IPMI_v2.xml` in zabbix web interface.
### Debian / Ubuntu
```bash
client# apt install python3 sudo zabbix-agent zabbix-sender smartmontools lm-sensors
@@ -39,10 +36,11 @@ client# yum install python3 sudo zabbix-agent zabbix-sender smartmontools lm_sen
server# yum install zabbix-get
```
### First step
+> **Note**: Your include directory may be either `zabbix_agentd.d` or `zabbix_agentd.conf.d` dependent on the distribution.
#### Linux
```bash
client# mv mini_ipmi_smartctl.py Linux/mini_ipmi_lmsensors.py sender_wrapper.py /etc/zabbix/scripts/
-client# mv Linux/sudoers.d/zabbix /etc/sudoers.d/ # place sudoers include here for mini_ipmi_smartctl.py sudo access
+client# mv Linux/sudoers.d/zabbix /etc/sudoers.d/ # place sudoers include for smartctl sudo access
client# mv Linux/zabbix_agentd.d/userparameter_mini-ipmi2.conf /etc/zabbix/zabbix_agentd.d/
```
@@ -50,25 +48,25 @@ client# mv Linux/zabbix_agentd.d/userparameter_mini-ipmi2.conf /etc/zabbix/zabbi
```bash
client# mv mini_ipmi_smartctl.py BSD/mini_ipmi_bsdcpu.py sender_wrapper.py /etc/zabbix/scripts/
client# mv BSD/sudoers.d/zabbix /usr/local/etc/sudoers.d/
-client# mv BSD/zabbix_agentd.conf.d/userparameter_mini-ipmi2.conf /usr/local/etc/zabbix/zabbix_agentd.d/
+client# mv BSD/zabbix_agentd.d/userparameter_mini-ipmi2.conf /usr/local/etc/zabbix/zabbix_agentd.d/
```
Then, for Intel processor you need to add `coretemp_load="YES"` to `/boot/loader.conf`. For AMD it will be `amdtemp_load="YES"`. Reboot or manual `kldload` is required to take effect.
#### Windows
```cmd
-client> move mini_ipmi_smartctl.py C:\zabbix-agent\scripts\
-client> move mini_ipmi_ohmr.py C:\zabbix-agent\scripts\
-client> move sender_wrapper.py C:\zabbix-agent\scripts\
-client> move userparameter_mini-ipmi2.conf C:\zabbix-agent\zabbix_agentd.conf.d\
+client> move mini_ipmi_smartctl.py "C:\Program Files\Zabbix Agent\scripts\"
+client> move mini_ipmi_ohmr.py "C:\Program Files\Zabbix Agent\scripts\"
+client> move sender_wrapper.py "C:\Program Files\Zabbix Agent\scripts\"
+client> move userparameter_mini-ipmi2.conf "C:\Program Files\Zabbix Agent\zabbix_agentd.d\"
```
-Install [python3](https://www.python.org/downloads/windows/), [adding it to](https://github.com/nobodysu/zabbix-mini-IPMI/blob/master/screenshots/python-installation1.png) `PATH` during installation for [all users](https://github.com/nobodysu/zabbix-mini-IPMI/blob/master/screenshots/python-installation2.png). Install [smartmontools](https://www.smartmontools.org/wiki/Download#InstalltheWindowspackage) and add its bin folder to `PATH` in environment variables. `OpenHardwareMonitorReport` `0.8.0.5+` requires `.NET Framework 4`. `0.3.2.0` requires `.NET Framework 3`.
+Install [python3](https://www.python.org/downloads/windows/), [adding it to](https://github.com/nobody43/zabbix-mini-IPMI/blob/master/screenshots/python-installation1.png) `PATH` during installation for [all users](https://github.com/nobody43/zabbix-mini-IPMI/blob/master/screenshots/python-installation2.png). Install [smartmontools](https://www.smartmontools.org/wiki/Download#InstalltheWindowspackage) and add its bin folder to `PATH` in environment variables. `OpenHardwareMonitorReport` `0.8.0.5+` requires `.NET Framework 4`. `0.3.2.0` requires `.NET Framework 3`.
### Second step
-Then you need to include your zabbix conf folder in `zabbix_agentd.conf`, like this:
+Dependent on the distribution, you may need to include your zabbix conf folder in `zabbix_agentd.conf`, like this:
```conf
-Include=/usr/local/etc/zabbix/zabbix_agentd.conf.d/
+Include=/usr/local/etc/zabbix/zabbix_agentd.d/
```
-Also its recomended to add at least `Timeout=10` to config file to allow drives spun up and OHMR execution.
+Its recomended to add at least `Timeout=10` to server and client config files to allow drives spun up and OHMR execution.
Thats all for Windows. For others run the following to finish configuration:
```bash
@@ -101,7 +99,7 @@ server$ zabbix_get -s 192.0.2.1 -k mini.disktemp.discovery[getverb,"Example host
or locally:
```mixed
client$ /etc/zabbix/scripts/mini_ipmi_lmsensors.py getverb "Example host"
-client_admin!_console> python "C:\zabbix-agent\scripts\mini_ipmi_ohmr.py" getverb "Example host"
+client_admin!_console> python "C:\Program Files\Zabbix Agent\scripts\mini_ipmi_ohmr.py" getverb "Example host"
```
Verbose mode. Does not detaches or prints LLD. Lists all items sent to zabbix-sender, also it is possible to see sender output in this mode.
@@ -116,15 +114,18 @@ These scripts were tested to work with following configurations:
- FreeBSD 10.3 / Zabbix 3.0 / Python 3.6
- Windows XP / Zabbix 3.0 / Python 3.4
+## Updating
+Overwrite scripts and UserParameters. If UserParameters were changed - agent restart is required. If template had changed from previous version - update it in zabbix web interface [marking](https://github.com/nobody43/zabbix-smartmontools/blob/master/screenshots/template-updating.png) all `Delete missing` checkboxes.
+
+> **Note**: low values in php settings `/etc/httpd/conf.d/zabbix.conf` may result in request failure. Especially `php_value memory_limit`.
+
## Known issues
-- Zabbix web panel displays an error on json discovery, but everything works fine ([#18](https://github.com/nobodysu/zabbix-mini-IPMI/issues/18))
-- Windows version does not detaches, and data will only be gathered on second pass (probably permanent workaround)
+- Zabbix web panel displays an error on json discovery, but everything works fine ([#18](https://github.com/nobody43/zabbix-mini-IPMI/issues/18))
+- Windows version does not detaches, and data will only be gathered on second pass
## Links
- https://www.smartmontools.org
- https://wiki.archlinux.org/index.php/Lm_sensors
- https://github.com/openhardwaremonitor/openhardwaremonitor
- https://unlicense.org
-- [Disk SMART monitoring solution](https://github.com/nobodysu/zabbix-smartmontools)
-- [Last Zabbix 2.4 version](https://github.com/nobodysu/zabbix-mini-IPMI/tree/last_zabbix24_unsupported)
-- [Older unsupported mini-IPMI version with simpler approach](https://github.com/nobodysu/zabbix-mini-IPMI/tree/old_v1_unsupported)
+- [Disk SMART monitoring solution](https://github.com/nobody43/zabbix-smartmontools)