commit f13f8a2f83d068d05e9d6d1c5655b80d1edbb0e2
parent ba0cc2e418eaa6deddb11e281c19a687e89f8370
Author: Nick Mathewson <nickm@torproject.org>
Date: Thu, 27 Mar 2025 15:13:16 -0400
Clarify family ID key file names
Diffstat:
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/doc/man/tor.1.txt b/doc/man/tor.1.txt
@@ -2485,7 +2485,8 @@ is non-zero):
[[FamilyId]] **FamilyId** __ident__::
Configure this relay to be part of a family
identified by a shared secret family key with the given key identity.
- A corresponding family key must be stored in the relay's key directory.
+ A corresponding family key must be stored in the relay's key directory,
+ with a filename ending with ".secret\_family\_key".
This option can appear multiple times.
Family keys are generated with "--keygen-family";
this also generates the value you should use in the __ident__ field
@@ -2505,6 +2506,7 @@ is non-zero):
[[FamilyIdStar]] **FamilyId** ** * **::
Configure this relay to be part of _every_ family
identified by any family ID key found in the family key directory.
+ Only filenames ending with ".secret\_family\_key" are considered.
Specifying family IDs in this way makes it unnecessary to adjust the
configuration file if the family key is rotated,
but it increases the likelihood of accidentally using a different
