No Description

Marcus Scharf 1450c21410 re-add verbose-options 7 years ago
lib 1450c21410 re-add verbose-options 7 years ago
.editorconfig a90c91b4f0 update README, unify example files 8 years ago
.gitignore f4126537e7 rework code-struct to classes 7 years ago
LICENSE 84ed0af3f3 update README and add LICENSE 8 years ago
README.md 7ac0b9ccd1 add optional rate limit 7 years ago
alias.json.example 7a036865e5 add vpn: true 7 years ago
config.json.example c61cc69a71 fix syntax error 7 years ago
ext-respondd.py 1450c21410 re-add verbose-options 7 years ago
ext-respondd.service.example d7ae616530 change path 7 years ago

README.md

respondd Status for Servers

A gluon compatible status script for respondd in python.

Dependencies

  • lsb_release
  • ethtool
  • python3.3
  • python3-netifaces
  • batman-adv

Setup

Debian-Dependencies

apt-get install python3-netifaces ethtool lsb-release

config.json

Startparameter for ext-respondd.
Copy config.json.example to config.json and change it to match your server configuration.
(cp config.json.example config.json)

  • batman (string) (Needed: typical bat0)
  • bridge (string) (Needed: typical br-client)
  • mesh-wlan (array of string) (Optional: Ad-Hoc batman-Mesh)
  • mesh-vpn (array of string) (Optional: fastd, GRE, L2TP batman-Mesh)
  • fastd_socket (string) (Optional: needed for uplink-flag)
  • rate_limit (integer) (Optional: limit incoming requests per minutes)
  • rate_limit_burst (integer) (Optional: 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.
(cp alias.json.example alias.json)

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 !
systemctl enable ext-respondd
systemctl start ext-respondd

Notes

Add this to your aliases.json in your HopGlass-Server if this a gateway.

  "gw2": {
    "nodeinfo": {
      "hostname": "Gateway 2",
      "node_id": "gw2"
    },
    "flags": {
      "gateway": true
    }
  }

Related projects

Collecting data from respondd:

Respondd for servers: