From: Kyle Meyer <kyle@kyleam.com>
Date: Mon, 19 Apr 2021 03:00:00 +0000 (-0400)
Subject: doc config: mention obfuscation-related options
X-Git-Tag: v1.7.0~791
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=560f9442d058925dd3a8171e8739826768188288;p=public-inbox.git

doc config: mention obfuscation-related options

Obfuscation has been available since v1.0.0.  Help those that want to
use the feature figure out how.
---

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index f8edf6f6..36d6bff2 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -322,6 +322,22 @@ always contain all git repos used by the inbox at C<$INBOX_URL>
 
 Default: C<match=domain>
 
+=item publicinbox.<name>.obfuscate
+
+Whether to obfuscate email addresses in the L<PublicInbox::WWW> HTML
+interface.
+
+Default: false
+
+=item publicinbox.noObfuscate
+
+A space-delimited list of well-known addresses and domains that should
+not be obfuscated when C<publicinbox.$NAME.obfuscate> is true (e.g.,
+C<public@example.com> and C<@example.com>).  This may be specified
+more than once, in which case the values are merged.
+
+Default: none
+
 =back
 
 =head2 NAMED LIMITER (PSGI)