Brokeret LogoDocs
Plugins / Bonus Manager/Installation

Installation

Step-by-step guide to installing the Bonus Manager plugin.

Requirements

  • MetaTrader 5 Server (x64)
  • Windows Server with MT5 Trade Server running
  • Server public IP whitelisted by Brokeret (contact the Brokeret team)

Installation Steps

  1. Copy the plugin DLL — Place BrokeretBonusManager64.dll into your MT5 server's plugins directory
  2. Whitelist API port — If using the REST API for remote management, whitelist port 8447 (default) in your firewall
  3. Enable in MT5 Admin — Open MT5 Administrator → Server → Plugins → Add → select Brokeret Bonus Manager → set to Enabled → Save
  4. Configure parameters — Set API_Key, API_Port, and other plugin parameters as needed
  5. Create campaigns — Use the REST API to create bonus campaigns targeting your desired groups
💡
TipThe minimum setup is: set an API_Key, then create one campaign via the API, e.g. a 30% credit bonus for all real\* groups. The plugin will start granting bonuses on qualifying deposits immediately.

Licensing

The Bonus Manager plugin requires IP whitelisting. No license keys or manual activation is needed — simply provide your MT5 server's public IP address to the Brokeret team and it will be whitelisted.

Once your IP is whitelisted, the plugin activates automatically on startup. If your server IP changes, contact Brokeret to update the whitelist.

📧
NoteContact the Brokeret team with your server's public IP address to get started.

Verifying Installation

Check the MT5 server journal for:

Brokeret Bonus Manager v1.00 — Copyright 2026, Brokeret
BrokeretBM: license VALID
BrokeretBM: plugin started, monitoring deals

You can also verify via the API:

curl -H "X-API-Key: your-key" http://<server_ip>:8447/api/status

A successful response includes:

{
  "plugin": "Brokeret Bonus Manager",
  "version": "1.00",
  "license_active": true,
  "campaigns_total": 0,
  "bonuses_total": 0
}
⚠️
WarningChange the default API key before deploying to production. Set the API_Key plugin parameter in MT5 Administrator to a strong, unique value. Leave API_Key empty to disable the API entirely.

Next Steps

  • Parameters — Learn about all configuration options and campaign settings
  • API Reference — Create campaigns and manage bonuses programmatically
Previous
Introduction
Next
Parameters