Update mailroom README & config example

Author: spacebear21

payjoin-mailroom/README.md

@@ -34,21 +34,21 @@ nix run .#payjoin-mailroom -- --config payjoin-mailroom/config.toml
 
 ## Telemetry
 
-payjoin-mailroom supports **optional** OpenTelemetry-based telemetry (metrics, traces, and logs). Build with `--features telemetry` and add a `[telemetry]` section to your config:
+payjoin-mailroom supports **optional** OpenTelemetry-based telemetry (metrics).
+Build with `--features telemetry` and configure via the [`[telemetry]`](config.example.com) config section.
+When no telemetry configuration is present, it falls back to local-only console tracing.
 
-```toml
-[telemetry]
-endpoint = "https://otlp-gateway-prod-us-west-0.grafana.net/otlp"
-auth_token = "<base64 instanceID:token>"
-operator_domain = "your-domain.example.com"
-```
+## Access Control
 
-Or set the equivalent environment variables:
+Build with `--features access-control` to enable:
 
-```sh
-export PJ_TELEMETRY__ENDPOINT="https://otlp-gateway-prod-us-west-0.grafana.net/otlp"
-export PJ_TELEMETRY__AUTH_TOKEN="<base64 instanceID:token>"
-export PJ_TELEMETRY__OPERATOR_DOMAIN="your-domain.example.com"
-```
+### IP Screening
+
+Configured via the [`[access_control]`](config.example.toml) config section for IP- and region-based filtering.
+
+The auto-fetched GeoLite2 database is provided by [MaxMind](https://www.maxmind.com) and distributed under the [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license.
+
+### V1 Address Screening
 
-When no `[telemetry]` section is present and no `PJ_TELEMETRY__*` variables are set, it falls back to local-only console tracing.
+When the V1 protocol is enabled, payjoin-mailroom can screen PSBTs for blocked Bitcoin addresses.
+Configure a local blocklist, a remote URL, or both via the [`[v1]`](config.example.toml) config section.

payjoin-mailroom/config.example.toml

@@ -2,7 +2,7 @@
 #
 # Configuration can also be set via environment variables with the `PJ_`
 # prefix.  Nested values use double underscores as separators, e.g.
-# PJ_ACCESS_CONTROL__BLOCKED_REGIONS=CU,IR,KP,SY
+# PJ_TELEMETRY__OPERATOR_DOMAIN="your-domain.example.com"
 
 # Address and port to listen on
 # listener = "[::]:8080"
@@ -13,19 +13,18 @@
 # Request timeout in seconds
 # timeout = 30
 
-# --- V1 protocol ---
-# Uncomment the [v1] section to enable V1 fallback support.
-# (address screening requires `access-control` feature)
-# [v1]
+# --- Telemetry (requires `--telemetry` feature) ---
+# [telemetry]
 
-# Path to a local file containing blocked Bitcoin addresses (one per line).
-# blocked_addresses_path = "/path/to/blocked_addresses.txt"
+# OpenTelemetry Protocol (OTLP) endpoint to export telemetry to
+# endpoint = "https://otlp-gateway-prod-us-west-0.grafana.net/otlp"
 
-# URL to periodically fetch an updated blocked-address list from.
-# blocked_addresses_url = "https://example.com/blocked_addresses.txt"
+# Authentication token for the OTLP endpoint 
+# auth_token = "<base64 instanceID:token>"
 
-# How often (in seconds) to refresh the remote address list (default: 86400).
-# blocked_addresses_refresh_secs = 86400
+# The domain you are running the payjoin-mailroom from.
+# This serves as an identifier for metrics collection.
+# operator_domain = "your-domain.example.com"
 
 # --- Access-control (requires `access-control` feature) ---
 # [access_control]
@@ -40,3 +39,17 @@
 
 # IP addresses or CIDR ranges whose requests should be blocked.
 # blocked_ips = ["192.0.2.0/24", "2001:db8::1"]
+
+# --- V1 protocol ---
+# Uncomment the [v1] section to enable V1 fallback support.
+# (address screening requires `access-control` feature)
+# [v1]
+
+# Path to a local file containing blocked Bitcoin addresses (one per line).
+# blocked_addresses_path = "/path/to/blocked_addresses.txt"
+
+# URL to periodically fetch an updated blocked-address list from.
+# blocked_addresses_url = "https://example.com/blocked_addresses.txt"
+
+# How often (in seconds) to refresh the remote address list (default: 86400).
+# blocked_addresses_refresh_secs = 86400