From ec2bbb1ea34f4193beee60e7430c8bced8376c8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20Rodr=C3=ADguez?= Date: Mon, 15 Jan 2024 18:28:37 -0500 Subject: [PATCH] Update comments in example config * Replace "discord" with "iMessage" * Explain how to use the nac options --- example-config.yaml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/example-config.yaml b/example-config.yaml index d2953d3..05b59ae 100644 --- a/example-config.yaml +++ b/example-config.yaml @@ -9,7 +9,7 @@ homeserver: # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here. software: standard # The URL to push real-time bridge status to. - # If set, the bridge will make POST requests to this URL whenever a user's discord connection state changes. + # If set, the bridge will make POST requests to this URL whenever a user's iMessage connection state changes. # The bridge will use the appservice as_token to authorize requests. status_endpoint: null # Endpoint for reporting per-message status. @@ -100,10 +100,15 @@ bridge: displayname_template: "{{.}} (iMessage)" # A URL to fetch validation data from. Use this option or the nac_plist option + # If connecting to a relay, use the base URL that the API is running under, without any trailing slashes, + # e.g. https://example.com nac_validation_data_url: http://example.com/validation_data + # If connecting to a relay, be sure to set the option below to true + nac_validation_is_relay: false # Optional auth token to use when fetching validation data. If null, defaults to passing the as_token. + # If using a relay, this must be the "registration code" generated by the iPhone or Mac registration provider + # Do not use the REGISTRATION_RELAY_SECRET, since that is unrelated! nac_validation_data_token: - nac_validation_is_relay: false # Servers to always allow double puppeting from double_puppet_server_map: