Added readme and PM2 configuration

This commit is contained in:
Mark van Renswoude 2021-08-18 11:38:47 +02:00
parent cc426c4c0f
commit 15d7c41278
2 changed files with 40 additions and 0 deletions

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# NotificationLatch
Filters notifications so that each one is only sent once until it is reactivated. Designed for use with Domoticz. At the time of writing only Pushover is supported as a target transport.
## Installing
Install Node.js, at least the current LTS version.
Install the dependencies and build the frontend:
```
npm install
cd frontend
npm install
npm run build
cd ..
```
Install PM2 and run the backend service:
```
npm install pm2 -g
pm2 startup
pm2 start .\ecosystem.config.js
pm2 save
```
## Configuring Domoticz
Go to Setup - Settings - Notifications. Enable Custom HTTP/Action and fill in the following information:
| Field | Value |
|--|--|
| URL/Action | ```http://localhost:3369/api/notification``` |
| POST Data: | ```subject=#SUBJECT&message=#MESSAGE&priority=#PRIORITY``` |
| POST Content-Type: | ```application/x-www-form-urlencoded``` |
| POST Headers: | ```Authorization: Bearer <authToken from config.js>``` |

6
ecosystem.config.js Normal file
View File

@ -0,0 +1,6 @@
module.exports = {
apps : [{
name : "NotificationLatch",
script : "./index.js"
}]
}