Skip to content

Search the store

Find products and categories.

Installation

Install Sentry on each Paper server of a Bridge network through the Aegis loader, then give staff and players their permissions.

Before you start

Sentry needs a working Bridge network. Set that up first with Bridge requirements. Each Paper server that runs Sentry also needs:

  • Kernel and Bridge, both included with Bridge.
  • packetevents.

Sentry runs on Paper servers only. Do not add it on the Velocity proxy.

Sentry reads and writes its reports, notes and anticheat logs through the same MongoDB and Redis that Bridge uses. It has no database settings of its own.

Install

Products are delivered through your personal Aegis loader. If the loader is not on the server yet, follow Installation first.

Add Sentry to the loader

On each Paper server, add Sentry under products: in the loader's config.yml, next to Bridge.

plugins/Aegis/config.yml
products:
  Sentry:
    enabled: true
    release: latest
    channel: stable
    required: true

Restart the server

Sentry loads after the products it depends on. On first start it creates sentry.yml, messages.yml and menus.yml in plugins/Sentry/.

Give out permissions

Sentry checks permission nodes. Grant them to your ranks with Bridge. A sensible start:

  • Staff ranks: sentry.staff, sentry.notifications, sentry.command.staffmode, sentry.command.vanish, sentry.command.freeze, sentry.command.reports, sentry.command.notes and bridge.chat.staff.
  • Your default rank: sentry.command.report, so players can use /report and /helpop.

The full list is on Permissions.

Check it works

  1. Join a Paper server with a staff account and run /staffmode. Your hotbar should hold an inspect book, a compass and a staff list.
  2. Run /staffmode again. Your inventory comes back.
  3. From a second account on the same server, run /report <name> on the staff account and pick a category. Staff on every server running Sentry should see the alert.

Settings live in plugins/Sentry/. See Configuration.