Dome/Advanced-Community-Bot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme with info about verify-migrate command and warning

Browse Source
This commit is contained in:
William Kray
2025-04-10 23:12:07 -07:00
parent f797c02fba
commit d3efb2ff5c
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -1
View File
@@ -148,7 +148,7 @@ please keep in mind that wordlist-based censorship is problematic and may redact
algorithm that is perfect is impossible. consider configuring your community such that censorship need only be applied algorithm that is perfect is impossible. consider configuring your community such that censorship need only be applied
in a limited subset of rooms. in a limited subset of rooms.
# user verification ## user verification
configure your rooms (all, or a list of room-ids) to use the `check_if_human` setting. use this in conjunction with a room power-level configuration that configure your rooms (all, or a list of room-ids) to use the `check_if_human` setting. use this in conjunction with a room power-level configuration that
requires elevated permission to send messages. for example, a "waiting-room" requires elevated permission to send messages. for example, a "waiting-room"
@@ -170,6 +170,13 @@ significant spam in your rooms. every permitted user goes in the state event, so
will become problematic and expensive for very large rooms... strong recommend not to will become problematic and expensive for very large rooms... strong recommend not to
use this if you expect to have thousands of room members. use this if you expect to have thousands of room members.
if you enable user verification in an existing room, but you don't want to disrupt the
current users' ability to send messages, you can use the `!community verify-migrate`
command to set permissions correctly. **DO NOT DO THIS IN LARGE ROOMS**. if you have more
than a handful of people, consider how many of them actually say anything in a given day
and whether or not it's worth filling your state event with them. consider alternative
options.
# installation # installation
install this like any other maubot plugin: zip the contents of this repo into a file and upload via the web interface, install this like any other maubot plugin: zip the contents of this repo into a file and upload via the web interface,