vagus/README.md
2024-09-16 18:10:21 +02:00

36 lines
1.2 KiB
Markdown

# Vagus - A heartbeat/keepalive daemon
Vagus is daemon that can exchange alive-information from instances so clients can get an overview of what is alive. It is meant to scale to at least 50 hosts.
It supports:
* IPv4 and IPv6
* UDP unicast
* UDP broadcast
* UDP multicast
* Multiple namespaces/clusters
It is not a full-fledged HA system. It merely provides a mechanism for building a HA system.
For configuration details please read details.md
# Platforms
Tested on:
* Python 2.7.6, 2.7.12, 3.6.15, 3.11.9
* Linux 3.11.10, 4.4.57, 4.4.62, 5.14.21
It will not work on Windows because it needs to discover network interfaces and addresses using the getifaddrs() system call.
## Installation
Vagus comes with an install script that installs it as a system service running under systemd.
1. clone the respository
2. with root priviliges run `install.sh`
Done. Vagus has now been installed into `/usr/local/vagus`, and it is already running.
It has a non-mandatory read-only web interface running on port 8724.
# Background
It was built for use in https://github.com/privacore/open-source-search-engine
The name Vagus comes from the vagus nerve which partially controls the human heart.