https://github.com/pakerfeldt/lovi

Lightweight pager app
https://github.com/pakerfeldt/lovi

alarm homeautomation pager

Last synced: 7 months ago
JSON representation

Lightweight pager app

• Host: GitHub
• URL: https://github.com/pakerfeldt/lovi
• Owner: pakerfeldt
• License: apache-2.0
• Created: 2019-02-22T21:51:23.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-02T08:08:23.000Z (about 5 years ago)
• Last Synced: 2025-01-19T19:45:28.504Z (9 months ago)
• Topics: alarm, homeautomation, pager
• Language: Go
• Homepage:
• Size: 142 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lovi

[![Build Status](https://travis-ci.org/pakerfeldt/lovi.svg?branch=master)](https://travis-ci.org/pakerfeldt/lovi)

Lovi is a lightweight pager application for message distribution. It offers a web api for triggering events and uses a policy configuration to determine how and to whom the events gets distributed.

This application currently supports the following transport mechanisms:

- SMS / Phone calls (through [46elks.se](https://46elks.se))

- stdout (for logging)

## How does it work?

Lovi is configured using a yaml file. Here you activate the transports you want to use and define the set of policies for which you plan to send events. A policy describes how events will be sent and to whom. See [Configuration](https://github.com/pakerfeldt/lovi/wiki/Configuration) wiki page for examples.

You can have multiple policies for different needs, each with its own set of configuration.

An event is triggered by calling `http://[your-ip]:8080/event/trigger/{policy}?message=Your%20message`.

## Running

The recommended way of running lovi is through Docker.

`docker run -p 8080:8080 -i -t pakerfeldt/lovi:1.0.0__linux_amd64`.

Lovi will try to read /config.yaml and listen to port 8080. You may want to change this by setting the `CONFIG` and `PORT` environment variables respectively.

## Contribute

See [Transports](https://github.com/pakerfeldt/lovi/wiki/Transports) wiki page for a guide on how to add new transports.