Added README

This commit is contained in:
Torsten Kurbad 2017-09-07 16:37:43 +02:00
parent 0273973538
commit 3f1d2e2d60
2 changed files with 27 additions and 1 deletions

26
README.md Normal file
View File

@ -0,0 +1,26 @@
pyupsmon
========
Monitor for Wöhrle CONVERT-1000 UPS written in Python3
Installation
------------
* Install pyyaml
```
sudo emerge -NDuv pyyaml
```
* Check out this project and copy the example config file to `/etc`
```
sudo cp pyupsmon.yml.example /etc/pyupsmon.yml
```
* Edit the config to your liking using your favourite text editor
* Install the `systemd` unit file
```
sudo cp pyupsmon.service /etc/systemd/system
```
* Enable and start the service
```
sudo systemctl enable pyupsmon.service
sudo systemctl start pyupsmon.service
```

View File

@ -32,5 +32,5 @@ shutdown:
# Shutdown command to execute after timeout expired # Shutdown command to execute after timeout expired
# #
# Default: /sbin/shutdown -h now # Default: /sbin/shutdown -h +2
#command: /sbin/shutdown -h now #command: /sbin/shutdown -h now