about summary refs log tree commit homepage
path: root/Documentation/public-inbox-config.pod
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2021-04-18 23:00:00 -0400
committerEric Wong <e@80x24.org>2021-04-18 23:09:27 -0400
commit560f9442d058925dd3a8171e8739826768188288 (patch)
tree8767b56ed6fa4b5a80fbcfe4f2a6499f16d53da3 /Documentation/public-inbox-config.pod
parent2018db2a23ab1d949c757c264534f39dba338ccb (diff)
downloadpublic-inbox-560f9442d058925dd3a8171e8739826768188288.tar.gz
Obfuscation has been available since v1.0.0.  Help those that want to
use the feature figure out how.
Diffstat (limited to 'Documentation/public-inbox-config.pod')
-rw-r--r--Documentation/public-inbox-config.pod16
1 files changed, 16 insertions, 0 deletions
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)