summaryrefslogtreecommitdiff
path: root/src/hub/README
blob: 38a5ec3755d49acf41c63318418b533d086abdaa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
sfive-hub
=========

`sfive-hub` is a service providing data aggregation, processing, persistence, and retrieval.

It accepts data updates via unix domain sockets and REST API, stores it persistently in
a key-value database and can be queried for data through a REST API. It can also forward
the data to a multitude of external analytics tools.

Unix domain sockets accept data in the same format as the REST API but are stateful
and use the information provided from the init message as specified in [sfive-protocol][].

[sfive-protocol]: git.spreadspace.org/sfive/doc/protocol.md