Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 1.68 KB

README.md

File metadata and controls

77 lines (47 loc) · 1.68 KB
Raw

humanode-tellr

A Humanode node (humanode-peer) bioauth status reporter; aka a "teller".

Intended to run on the same host as the Humanode node.

Serves a status report through a web server for monitoring.

An uptime keyword monitor service like UptimeRobot may be used to monitor the reporter and be alerted (by email, push notification, SMS, etc) if bioauth status becomes inactive or if the humanode-peer is down.

Configure

Copy the environment file, then edit to your preference.

cp .env-example .env

Run

with Node.js directly

npm install
npm run start

with Docker

docker compose build
docker compose up

Usage

Access the status report by URL. Use AUTH as set in .env within the URL.

  • If using IP address: http://$IPAddress/$AUTH/status
  • If using a domain + SSL: https://$HOSTNAME/$AUTH/status

Optionally report if bioauth is active but expiring within a given timeframe by appending minutes to the URL. For example, to report if bioauth expires within 10 minutes use the URL http://$IPAddress/$AUTH/status/10.

Output Format

bioauth is not active

Inactive

bioauth is active but expiring

Expiring

bioauth is active (example)

{"Active":{"expires_at":1683942000000}}

Uptime/Keyword Monitor

  • Monitor for keyword presence of "Active" (case sensitive) or "expires_at".

Example: UptimeRobot

image

Tips

If you find this tool useful, please consider sharing some $HMND. Thanks! 🚀

hmsWHFeUoJqCALP1q5WNq94Pr2KcY6K439NwN3S4vcHWL6NmV