Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

more docs #8

Merged
merged 1 commit into from
Nov 23, 2023
Merged

more docs #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)