Documentation · SpamGuard

Installation

Pre-release: this documentation describes the current development state and may change before release.

Requirements

• XenForo 2.3 (2.3.0 or later)
• PHP 8.1 or newer
• For the AI review (Pro): your own API key with an AI provider

Download

SpamGuard has not been released yet. The free Lite edition will be offered on xenforo.com later, the Pro edition through Lemon Squeezy. Until then there is no public download.

Install in the admin control panel

1. Open Add-ons in the ACP.
2. Choose Install/upgrade from archive and upload the ZIP file.
3. Confirm the installation. XenForo creates the tables and options.

Install manually

1. Extract the ZIP file.
2. Upload the contents of the upload/ folder to your forum’s root directory. The files end up in src/addons/ChpahlIT/SpamGuard.
3. In the ACP under Add-ons, click Install next to SpamGuard.

Or from the command line in the forum root:

php cmd.php xf-addon:install ChpahlIT/SpamGuard

Upgrade

A new version is installed the same way: upload the ZIP via Install/upgrade from archive, or replace the files and choose Upgrade in the ACP. From the command line:

php cmd.php xf-addon:upgrade ChpahlIT/SpamGuard

Uninstall

Uninstalling in the ACP removes all tables and options of the add-on, including the audit log. With a Pro licence, the licence is deactivated for this board so it can be used on another one.

Details

← Back to project page