@ghostmind-dev/relay
v0.8.2
Published
relay: runs on a machine at home and lets your apps in the cloud reach the things on that network
Readme
relay
Your apps run in the cloud. Your speakers, lights and sensors are at home, behind a router. relay is how the first reach the second: this program, left running on a machine at home, one account, and the apps you allow.
It needs Node.js 20 or later. On Linux, also the package avahi-utils.
npm install -g @ghostmind-dev/relay
relay login # your relay account (Google), once per machine
# it asks how: a browser here, or a code from another device (over SSH)
relay install # runs now and at every start (launchd agent / systemd user service)
relay allow <app> # let an app see and use what your relays see
relay status # the account, the service, your relays and their things, the allowed appsYour machines, their things and the apps you allow are also on a page: https://relay.ghostmind.dev.
It sees Google Cast speakers by itself. Lights and plugs come from your Zigbee2MQTT:
on the machine where it runs, relay finds its MQTT broker by itself; from another machine,
relay zigbee <address of the broker> says where it is, once.
relay things looks at this network without the cloud. relay start runs it in this terminal.
relay revoke <app>, relay logout and relay uninstall undo the above.
Everything the program remembers is in ~/.config/relay/relay.json, readable by you only. It opens no port:
every connection goes out from your machine.
