https://github.com/bryopsida/eureka

Discovery library to facilitate finding other pieces of a system on spin up
https://github.com/bryopsida/eureka

authenticated-encryption discovery multicast udp zeroconf

Last synced: 9 days ago
JSON representation

Discovery library to facilitate finding other pieces of a system on spin up

• Host: GitHub
• URL: https://github.com/bryopsida/eureka
• Owner: bryopsida
• License: unlicense
• Created: 2024-03-27T00:12:43.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-04T13:09:55.000Z (4 months ago)
• Last Synced: 2024-08-04T10:29:38.027Z (3 months ago)
• Topics: authenticated-encryption, discovery, multicast, udp, zeroconf
• Language: JavaScript
• Homepage:
• Size: 96.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Eureka

## What is this?

A simple library to share small bits of information across processes that are on the same multicast network

## How does it work?

The library is provided a pre shared key, this needs to be the same for all members.

Members can have properties set as 'their' properties which they broadcast for other members to discover properties about them.

When the current process receives a message on the multicast group, it decrypts, runs verification and then emits events for the upper

layer to consume.

## What about rotation of the PSK?

TBD, but things may retain knowledge of the previous key for a period of time, and when they see a message from a thing using the old key,

they may send a message using the old key informing the thing to move to the new key, or it may be a out of band process handed by other means.

## How do I use it?

Two implementations will exist, Node.JS, and Golang, the Node.JS will be available in npm, the golang implementation will be available as a gomodule.

### JSDoc Page

You can find a hosted JSDoc page of the latest release [here](https://bryopsida.github.io/eureka/)