]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Clarify family ID key file names
authorNick Mathewson <nickm@torproject.org>
Thu, 27 Mar 2025 19:13:16 +0000 (15:13 -0400)
committerNick Mathewson <nickm@torproject.org>
Thu, 27 Mar 2025 19:13:16 +0000 (15:13 -0400)
doc/man/tor.1.txt

index dc8e6875ceb0332c4bed108fd0ea3206d71d9424..cd8d3bde90eac5fe4a4137daf43cf44957067600 100644 (file)
@@ -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