]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc config: mention obfuscation-related options
authorKyle Meyer <kyle@kyleam.com>
Mon, 19 Apr 2021 03:00:00 +0000 (23:00 -0400)
committerEric Wong <e@80x24.org>
Mon, 19 Apr 2021 03:09:27 +0000 (23:09 -0400)
Obfuscation has been available since v1.0.0.  Help those that want to
use the feature figure out how.

Documentation/public-inbox-config.pod

index f8edf6f6b1c8b3e9048cbd85a8bcc4152761ad84..36d6bff23dc24731cd1751669a911e7a47df0784 100644 (file)
@@ -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)