/ext-respondd

respondd status for servers

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

respondd Status for Servers

A gluon compatible status script for respondd in python.

Dependencies

  • lsb_release
  • ethtool
  • python3 (>= 3.3)
  • python3-netifaces
  • batman-adv

Setup

Debian-Dependencies

apt-get install python3-netifaces ethtool lsb-release

config.json

Start parameter for ext-respondd.
Copy config.json.example to config.json and change it to match your server configuration.

  • "addr" (str / default: ff05::2:1001)
    • address to listen to
  • "port" (str / default: 1001)
    • port to listen to
  • "batman" (str / default: bat0)
    • batman-adv interface
  • "bridge" (str / default: br-client)
    • client bridge
  • "mesh-wlan" (str[])
    • ad hoc batman-mesh
  • "mesh-vpn" (str[])
    • fastd, GRE, L2TP batman-Mesh
  • "fastd_socket" (str)
    • needed for uplink-flag
  • "rate_limit" (int / default: 30)
    • limit incoming requests per minutes
  • "rate_limit_burst" (int / default: 10)
    • allow burst requests

alias.json

Aliases to overwrite the returned server data.
Copy alias.json.example to alias.json and input e.g. owner information.

The JSON content matches one block of the nodes.json, which is outputted by e.g. the HopGlass-Server.

ext-respondd.service

Register ext-respondd as a systemd service

cp ext-respondd.service.example /lib/systemd/system/ext-respondd.service
# modify the path inside of the ext-respondd.service if necessary
systemctl daemon-reload
systemctl enable ext-respondd
systemctl start ext-respondd

Related projects

Collecting data from respondd:

Respondd for servers: