From 57e0791022ed3bfdcb8feb7dcdaa20a93467ceaf Mon Sep 17 00:00:00 2001 From: Jakob Schlyter Date: Thu, 23 Nov 2023 14:55:00 +0100 Subject: [PATCH] update --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7fc0dd..99bfac6 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ -# Aggregate Receiver +# DNS TAPIR Aggregate Receiver +This repository contains the DNS TAPIR Aggregate Receiver, a server component use for submitting and retrieving TAPIR aggregates. +Submitted aggregates are stored in a S3 compatible object store with its metadata stored in MongoDB. New aggregates are announced via MQTT. + +Client are assumed to be authenticated using mTLS and all submitted data must be signed using [HTTP Message Signatures](https://tools.ietf.org/html/draft-ietf-httpbis-message-signatures). Public keys for allowed signers are stored in PEM format in the `CLIENTS_DATABASE` directory as `{key_id}.pem`. ## Configuration METADATA_BASE_URL = "http://127.0.0.1:5000" + + CLIENTS_DATABASE = "/etc/aggrec/clients" + S3_ENDPOINT_URL = "http://localhost:9000" S3_BUCKET = "aggregates" S3_BUCKET_CREATE = true S3_ACCESS_KEY_ID = "minioadmin" S3_SECRET_ACCESS_KEY = "minioadmin" + MONGODB_HOST = "mongodb://localhost/aggregates" + MQTT_BROKER = "localhost" MQTT_TOPIC = "aggregates" + + +## References + +- [DNS TAPIR Aggregate Receiver API v1](aggrec/openapi.yaml)