Getting started

Speculare Alerts is used to send notifications depending on the configured alerts.


As of now Speculare Alerts does not provide easy setup solution such as a one-line installer (but it's planned). The current recommanded way to install Speculare Alerts is to build it from source. But don't be afraid, it's easy and straightforwards.

Install dependencies

Speculare Alerts is a Rust project that rely on some dependencies to be able to be built correctly. Much of them are default deps in most servers.

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf | sh

# Install APT dependencies
sudo apt-get install libssl-dev libpq-dev pkg-config build-essential cmake

Build the binary

You can build the binary using:

cargo build --release

The resulting binary will be located in ./target/release/alerts.

Configuration files

The server binary depends on a alerts.config file whose path will be passed as arguments to the binary (default location is XXX).

You can create your alerts.config from the alerts.example.config given in the source code.

speculare-server "path/to/alerts.config"

Last updated