From 8cc4527ff749db95e1d606e6966a9b65338d96a0 Mon Sep 17 00:00:00 2001 From: James Lu Date: Fri, 1 Jun 2018 23:50:50 -0700 Subject: [PATCH] example-conf: initial documentation for the antispam plugin --- example-conf.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/example-conf.yml b/example-conf.yml index 0c19690..ac9f547 100644 --- a/example-conf.yml +++ b/example-conf.yml @@ -809,3 +809,30 @@ stats: # $current_fullnetwork: the full name of the network we're currently broadcasting on # $text: the global text #format: "[$sender@$fullnetwork] $text" + +#antispam: + # This block configures the antispam plugin; you don't need this if you aren't using it. + # Antispam is automatically enabled in all channels that it's in, and you can configure + # its presence (like with all service bots) by setting 'antispam_channels' on the applicable + # network. + # Antispam also integrates with relay by punishing users locally (so that bans, kills, etc. + # are not bounced by relay) and not relaying messages marked as spam. + + # IMPORTANT: Antispam is in ALPHA stagse as of 2.0-alpha3 and some options may not work yet. + + #masshighlight: + # This block configures options for antispam's mass highlight blocking. It can also + # be overriden (as an entire block) per-network by copying its options to + # servers::::antispam_masshighlight + + # Determines whether mass highlight prevention should be enabled. Defaults to + # false if not set. + #enabled: true + + # Sets the kick / kill message used when mass highlight prevention is triggered. + #reason: "Mass highlight spam is prohibited" + + # Sets the minimum message length and amount of nicks needed in a message for + # masshighlight prevention to trigger. + #min_length: 50 + #min_nicks: 5