Skip to content

pakerfeldt/lovi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lovi

Build Status

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)
  • 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 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 wiki page for a guide on how to add new transports.