Install and first steps

Download #

Before you install, check the requirements: Paper or Spigot 1.21 – 1.21.x or 26.1 – 26.3, and Java 21 or newer. Folia is not supported.

Install #

1. Put ManukaModeration-1.0.0.jar in your server's plugins/ folder.

2. Restart the server. Do not use /reload.

3. Watch the console. On every start Manuka Moderation prints its banner and a line like this one:

   Manuka Moderation v1.0.0 | Paper 1.21.11 | panel http://127.0.0.1:8765 | lang en | Free

The first start also creates plugins/ManukaModeration/config.yml. Chat is captured and analysed from that moment; there is no database or web server to install.

Commands in this guide are written for the game, with a slash (/mm status). In the server console, type them without the slash (mm status).

First steps #

1. Exempt yourself and allow your own links #

Your own account usually should not produce cases, and your own website and Discord invite should never count as advertising.

• Exempt your account: /mm exempt add <your name>. This edits exempt.players in config.yml and reloads it for you.

• List your community's website and Discord invite under advertising.allowed in config.yml, then run /mm reload:

  advertising:
    allowed: [myserver.net, discord.gg/abc123]

2. Get into the panel #

As an operator (operators have manukamod.admin, which allows every command and every panel section), either:

• run /mm panel in game: you get a clickable login link, valid for 10 minutes and usable once. This is the safest way in, because no password is typed in chat; or
• set a panel password with /mm password <at least 8 characters>, then log in with your Minecraft name and that password. The plugin keeps this line out of the server log, but other plugins (a command spy, for example) can still see it.

3. Open the panel #

The panel listens on http://127.0.0.1:8765, which means it only answers on the server machine itself. Open that address in a browser there and log in with your Minecraft name.

To reach it from your own computer:

• For a quick look, use an SSH tunnel: ssh -L 8765:127.0.0.1:8765 user@your-server, then open http://127.0.0.1:8765/ on your computer.
• For everyday use, put the panel behind a reverse proxy with HTTPS (recommended), or turn on the plugin's built-in HTTPS. See the panel guide.

4. Give your staff access #

1. Grant manukamod.panel to every staff member who should log in. It allows /mm panel and /mm password.

2. List their LuckPerms or Vault groups under access.groups in config.yml, with what each group may see. On Free, only the first two groups in the list count.

   access:
     groups:
       owner: { violations: [all], punishments: true, logs: true, analytics: true, settings: true, users: true, ai: true }
       admin: { violations: [all], punishments: true, logs: true, analytics: true, settings: false, users: false, ai: true }

3. Grant manukamod.alerts to staff who should get in-game alerts.

4. Run /mm reload.

With LuckPerms, from the console:

lp group mod permission set manukamod.panel true
lp group mod permission set manukamod.alerts true

You can also create accounts yourself with /mm user add <name> [password], for players who have joined the server at least once. An account never grants anything by itself: what it can see always comes from the player's groups and permissions.

5. Optional extras #

• E-mail alerts and digests: fill in the email section of config.yml and test it with /mm email test <address>. See Configuration.
• AI explanations: add your own Anthropic or OpenAI-compatible key in the ai section and test it with /mm ai test. See Configuration.
• Pro: activate your key with mm license activate <key>. See Licensing and payment.

Updating #

Manuka Moderation looks for new releases about a minute after the server starts and then every 6 hours, and tells the console, the panel and players with manukamod.update.notify.

• /mm update download downloads the new version into the server's update folder. It is applied on the next restart, and only after its signature checks out. This works on Free and Pro.
• On Pro, updates.auto-download: true does the download for you.
• You can also replace the jar in plugins/ yourself and restart the server.

When a new version adds settings, your config.yml is upgraded on start: missing keys are added with their comments, existing lines are never rewritten, and a copy of the old file is kept.