Ban Syncing
Share bans between the servers in a pool, with a sync direction for each server.
Overview
The "Ban Sync" feature in Cakey Bot lets server owners manage bans across multiple servers within a designated pool. It cuts down moderation work and keeps bans consistent across interconnected communities.
How It Works
Server Pool Creation: Server owners start the ban synchronization process by creating a designated pool of servers through the web dashboard.
Ban Replication: When a user is banned in a server in the established pool, the bot identifies this ban and replicates the same action across all other connected servers.
Quick Updates: The Ban Sync feature processes bans via a queue, which prevents the bot from being restricted by ratelimits. Bans are also checked when a user joins the server, which allows almost real-time enforcement by banning users instantly who have not been processed by the queue yet.
Multi-Way Syncing: Within a designated pool, bans are synchronized across all servers, irrespective of the server where the ban was initially issued. This means bans will sync across all servers within the pool even if the ban did not originate in the server that created the pool.
Note: If a server is in multiple pools, it is possible for the ban to propagate across multiple pools.
If you don't want a specific ban to be automatically synced, you may include the -nosync flag in the ban reason and it will be ignored by the ban sync feature. Note, however, that unbans will ALWAYS be synced since you are unable to provide a reason. Bans made by the Honeypot are skipped the same way unless you turn on its Sync bans with Ban Sync switch.
Creating a Pool
Currently servers are limited to creating 1 pool per server. However, servers can be included in any number of pools.
To create a new pool, log in to the web dashboard and follow these steps:
- Open the "Ban Sync" page
- Click the "Create New Ban Sync Pool" button
- Once the creation modal opens, enter a name and click the "Create" button
You have now created your first ban sync pool. Read the section below to add servers to your newly created pool.
Toggling Ban Sync Feature
By default servers are NOT allowed to be added to pools. To allow the server to be added to a pool, click the "Enable Ban Sync for this server" button on the Ban Sync page.
You will need to enable ban sync for every server you wish to add to a ban sync pool.
Note: Once the server has been added to a pool you can disable this toggle again to prevent the server from being added to other pools. This toggle will NOT remove servers from existing pools, it only prevents the server from being added to new pools.
Adding Servers to Pools
The number of servers allowed in a given pool at once is tiered:
- 3 for free servers
- 7 for Premium servers
- 15 for Custom Bot (whitelabel) servers
However, a server can be included in multiple different pools.
While on the Ban Sync page follow these steps:
- Click the grey box inside of the selected pool under the text "Servers:"
- This should bring up a selection menu for all of the servers that you are in
- Select the servers you wish to add to the pool, they will automatically be added
By default, servers will NOT be able to be added to Ban Sync pools. You will have to manually toggle this to be "Enabled" on each server you wish to add.
Configuring Ban Sync Direction
Cakey Bot has 3 direction types. They can be set independently for both bans and unbans depending on your needs. The 3 types are:
- Two-Way (Default Behavior)
- Servers that have this set will both send bans/unbans to other servers in the pool as well as receive bans/unbans from other servers in the pool.
- Only Share
- Servers that have this set will only send their own bans/unbans to the rest of the pool and will not receive bans/unbans from other servers in the pool.
- Only Receive
- Servers that have this set will only receive bans/unbans from other servers in the pool and will not broadcast their own bans/unbans to the rest of the pool.
Note: Since these can be mix & matched, you should take note of how they will interact with each other. For example, if server A is set to "Two-Way" but server B is set to "Only Receive" then any bans in server B will NOT send to server A even though server A is set to Two-Way.
Removing Servers from Pools
Only the server that created the pool can remove servers from the pool. Servers that have been added to the pool can choose to "leave" the pool however.
While on the Ban Sync page follow these steps:
- Inside the grey box under the text "Servers:" you will see a list of servers in the pool
- Click the white "X" button for any servers you wish to be removed. If you do not see the white "X", then you are likely viewing the pool from a server that was added to the pool and not from the server that created the pool.
Leaving a Pool
Servers that create a pool will only be able to delete the pool, they can not leave the pool.
Servers that have been added to a pool will be able to see that they have been added to the pool. In addition to this, they will be able to leave the pool. Servers that are added to pools will not be able to edit other servers in the pool or delete them. Only the server that created the pool will be able to manage it. To leave a pool, click the orange "Leave" button at the bottom of the pool.