From bc2b610031b832240f939f9dabdc549c3a6d1182 Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Sun, 7 May 2023 15:04:42 -0700 Subject: [PATCH] docs/AntiAbuse: update automatic join-flood enforcement section --- doc/AntiAbuse.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/AntiAbuse.md b/doc/AntiAbuse.md index 220ac85c..7e90889b 100644 --- a/doc/AntiAbuse.md +++ b/doc/AntiAbuse.md @@ -59,8 +59,8 @@ PBot performs its join-flood enforcement in a separate channel to reduce noise i Let's say you want to set up join-flood enforcement for your channel, let's call it `#chan`. Here are all of the steps required to do that. Be sure to replace all occurences of `#chan` with your actual channel, including within `#chan-floodbans`. -* Create and register the `#stop-join-flood` channel. This is where PBot will forward join-flooders. Give it a sensible `/topic` like "You have been forwarded here due to join-flooding. If your IRC client or network issues have been resolved, you may `/msg PBot unbanme` to remove the ban-forward." If the channel already exists, you may configure the `antiflood.join_flood_channel` registry entry to point at a different channel (see [regset](Registry.md#regset)). +* Create and register the `#stop-join-flood` channel. This is where PBot will forward join-flooders. Set its `/topic` to "You have been forwarded here due to join-flooding. If your IRC client or network issues have been resolved, you may `/msg PBot unbanme` to remove the ban-forward." Replace "PBot" with your bot's IRC nick. If the channel already exists, you may configure the `antiflood.join_flood_channel` registry entry to point at a different channel (see [regset](Registry.md#regset)). +* Set an extended-ban in `#chan`: `/mode #chan +b $j:#chan-floodbans$#stop-join-flood`. This will retrieve the bans from `#chan-floodbans` for use in `#chan` and forward banned users to `#stop-join-flood`. Use the channel you configured in `antiflood.join_flood_channel` if someone else has already created `#stop-join-flood`. * Create and register the `#chan-floodbans` channel. This is where your instance of PBot will do the banning/unbanning; give it channel OPs here (`chanadd #chan-floodbans`, `chanset #chan-floodbans chanop 1` and optionally `chanset #chan-floodbans permop 1`). Be sure add PBot to the channel's access list for +o via ChanServ or equivalent. -* Set an extended-ban in `#chan`: `/mode #chan +b $j:#chan-floodbans$#stop-join-flood`. This will retrieve the bans from `#chan-floodbans` for use in `#chan`. * Join PBot to both `#chan` and `#chan-floodbans` so it can monitor `#chan` and set/remove the bans in `#chan-floodbans`. * Optionally, configure the `#chan.join_flood_threshold` and `#chan.join_flood_time_threshold` registry entries if the defaults are not desirable (see [regset](Registry.md#regset)).