From 0281de918705f3496b9c02a3a60501d61a8463da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= Date: Sun, 17 Oct 2021 21:57:40 +0200 Subject: [PATCH] README: add info about configuring access lists --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index b6f1100..9f50ad1 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,14 @@ The configuration file values you will most likely want to adjust are `address` under the `network` section (listening address). This goes for all three protocols. +Access control by info hash is supported for all protocols: + +```toml +[access_list] +mode = 'off' # Change to 'black' (blacklist) or 'white' (whitelist) +path = '' # Path to text file with newline-delimited hex-encoded info hashes +``` + Some documentation of the various options might be available under `src/lib/config.rs` in crates `aquatic_udp`, `aquatic_http`, `aquatic_ws`.