Extension:CrowdSec
CrowdSec Release status: experimental |
|
---|---|
Implementation | Page action |
Description | Bouncer Integration with CrowdSec for anti-spam. |
Author(s) | MPThLeetalk |
MediaWiki | 1.35+ |
License | GNU General Public License 2.0 or later |
Download | GitHub: Note: |
|
|
|
|
This extension adds anti-spam integration with CrowdSec. As it's working as bouncer, It's mandatory to setup CrowdSec Agent too.
Installation
edit- Download on GitHub and place the file(s) in a directory called
CrowdSec
in yourextensions/
folder. - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'CrowdSec' );
- Configure as required.
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
editStep 1: Setup CrowdSec Agent
editFollow this documentation from CrowdSec. You may need to setup the collections, logs and more too.
Then, you need to get a bouncer api token.
sudo cscli bouncers add mediawiki-bouncer
Remember the token key. It need to put on extension configuration.
It's highly recommended to register Central API for pull blocklist from remote.
sudo cscli capi register
Step 2: Setup Extension
editwfLoadExtension( 'CrowdSec' );
$wgCrowdSecAPIKey = ""; // put lapi key here.
This is basic configuration. More configuration is documented on README
AbuseFilter Integration
editThere's AbuseFilter integration. The variable crowdsec_blocked
is representing...
false
: LAPI Request was failed. or failed to get user ip.'ok'
: This user is ok to process.'ban'
: This user is reported for "ban" from LAPI.- ... and various (custom) types via CrowdSec. including
'captcha'
User rights
editcrowdsec-bypass
- allows users to bypass crowdsec check.
See also
edit- Extension:StopForumSpam - main functionality based on this extension.