From 05a82b6de99e4041ddacd472432a7e30854ad6a3 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Fri, 21 Feb 2025 10:12:56 -0500
Subject: [PATCH] Fill in URL for FamilyId support.
---
changes/happy-families | 3 ++-
doc/man/tor.1.txt | 8 +++++---
src/feature/relay/routerkeys.c | 5 ++++-
3 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/changes/happy-families b/changes/happy-families
index 5a56cb1b29..c4520129c9 100644
--- a/changes/happy-families
+++ b/changes/happy-families
@@ -13,4 +13,5 @@
thereby simplifying family operation,
and making microdescriptor downloads approximately 80% smaller.
- For more information, see (XXXX INSERT URL HERE).
+ For more information, see
+ https://community.torproject.org/relay/setup/post-install/family-ids/
diff --git a/doc/man/tor.1.txt b/doc/man/tor.1.txt
index 39e270ee4b..efe78f2004 100644
--- a/doc/man/tor.1.txt
+++ b/doc/man/tor.1.txt
@@ -173,7 +173,8 @@ The following options in this section are only recognized on the
To use this key, install it on every relay in your family.
(Put it in the relay's `KeyDirectory`.)
Then enable the corresponding FamilyID option on your relays.
- See (XXXX INSERT URL HERE) for more information.
+ See https://community.torproject.org/relay/setup/post-install/family-ids/
+ for more information.
**`--passphrase-fd`** __FILEDES__::
File descriptor to read the passphrase from. Note that unlike with the
@@ -2488,7 +2489,7 @@ is non-zero):
this also generates the value you should use in the __ident__ field
in a file ending with ".public\_family\_id".
For information on generating and installing a family
- key, see (XXXX INSERT URL HERE).
+ key, see https://community.torproject.org/relay/setup/post-install/family-ids/
+
In the future, this will be the preferred way for relays
to advertise family membership.
@@ -4067,7 +4068,8 @@ __KeyDirectory__/**`secret_onion_key_ntor`** and **`secret_onion_key_ntor.old`**
__KeyDirectory__/__keyname__**`.secret_family_key`**::
A relay family's family identity key.
Used to prove membership in a relay family.
- See (XXXX INSERT URL HERE) for more information.
+ See https://community.torproject.org/relay/setup/post-install/family-ids/
+ for more information.
__DataDirectory__/**`fingerprint`**::
Only used by servers. Contains the fingerprint of the server's RSA
diff --git a/src/feature/relay/routerkeys.c b/src/feature/relay/routerkeys.c
index 755c19c603..39c56fcf1f 100644
--- a/src/feature/relay/routerkeys.c
+++ b/src/feature/relay/routerkeys.c
@@ -878,6 +878,9 @@ load_family_id_keys(const or_options_t *options,
return 0;
}
+#define FAMILY_INFO_URL \
+ "https://community.torproject.org/relay/setup/post-install/family-ids/"
+
/** Generate warnings as appropriate about our family ID configuration.
*
* `options` is required; `ns` may be NULL.
@@ -907,7 +910,7 @@ warn_about_family_id_config(const or_options_t *options,
"MyFamily was configured, but FamilyId was not. "
"It's a good time to start migrating your relays "
"to use family keys. "
- "See (XXXX INSERT URL HERE) for instructions.");
+ "See "FAMILY_INFO_URL " for instructions.");
have_warned_absent_familykeys = 1;
}
}
--
GitLab