☰ Contents: MRadmin
For admins

Configuration

Easiest in the browser: web interface → Server → Main server → Configuration → MRadmin - every setting with an explanation, saving reloads MRadmin right away (permission mradmin.config). Everything is also commented in plugins/MRadmin/config.yml, in the same layout as in all MRtechnology plugins; you apply changes by hand with /mradmin reload. Only in the file: your own dashboard buttons (admin-mode.menu.buttons), web.roles / web.players and new ticket categories.

Section What for More
general language, fallback-language, server-language (languages, automatically per player) and timezone (time zone of all displayed times, empty = the server's) Language
features · integrations · libertybans Features and plugin connections on/off, quick-select for punishments Quick start, Working with other plugins
maintenance · uptime-kuma How maintenance works, connection to Uptime Kuma Maintenance
announce Announcements in game Announcements
admin-mode Admin mode, menu item, own dashboard buttons Dashboard & admin mode
tickets Categories, cooldowns, limits, how long closed tickets are kept Handling tickets
health History and TPS alarm
versions Server → Plugins: how often it is checked, automatic downloads, pre-releases, how the restart button restarts Plugins & updates
server Starter: memory, Java options, Paper updates, daily restarts, crash and hang rules Starter
storage Storage: yaml (default), sqlite or mysql Storage
web · mail Web interface, mails for contact and unban requests Web interface
player-web Player page (/web): on/off, sign-in with a code, rankings, news, own statistics tile Player page
map Map: install, update and set up squaremap automatically, hide worlds of plugins, nether-roof, player-page Map
logging How many days the log is kept (keep-days, 1-14)
discord · discord-announce Admin log via webhook, announcements on the community Discord Discord
updates · gui Update notices, menus

Language

All messages, templates and Discord texts are in plugins/MRadmin/lang/<language>.yml. New messages from updates are added automatically. General information under Languages & messages.

  • Server language: Discord logs and announcements, the server list during maintenance, push notifications, mails and notes in tickets have no single recipient - they use general.server-language (default en). On a German server, set server-language: de.
  • Every player sees announcements, the maintenance countdown, boss bars and titles in their language. The web interface follows the browser's language - or the language you switched to there.

Storage: YAML, SQLite or MySQL

storage.type Where What for
yaml (default) Files in the plugin folder small servers
sqlite plugins/MRadmin/mradmin.db many tickets, the web interface
mysql MySQL or MariaDB several servers with shared tickets

To switch: change type and restart the server - the existing data is taken over. Paper downloads the database drivers by itself on the first start. /mradmin storage shows the state.

Discord

For the admin log create a webhook (Edit channel → Integrations → Webhooks), enable it under discord and enter the URL. Which events are sent (tickets, maintenance, admin mode, web sign-ins …) you set under discord.events. Test: /mradmin discord test.

The other MRtechnology plugins can send their logs through this webhook (discord.use-mradmin-webhook in their config). All events are also in the log of the web interface. For announcements in the public channel there is the separate webhook discord-announce - see Announcements.

All settings

Every setting of config.yml with its default - the same fields as in MRadmin's browser form. The list is generated automatically from the plugin and therefore always matches this version.

General

Language of the texts in game, on Discord and in mails, time zone.

Setting Default Meaning
general.language Automatic (auto) Language of the players - Automatic = every player gets the language of their Minecraft client. The web interface follows the browser.
general.fallback-language English (en) Fallback language - For players whose language has no file of its own.
general.server-language English (en) Server language - Discord, server list during maintenance, push, mails, notes in tickets.
general.timezone empty Time zone - E.g. Europe/Vienna. Empty = the server's time zone.

Features

A switched-off feature disappears completely - stored data is kept and back when switching it on.

Setting Default Meaning
features.maintenance on Maintenance mode - Countdown, boss bar, MOTD, join lock (incl. Uptime Kuma).
features.announce on Announcements - Announcements with /mradmin announce and the announcement menu in the dashboard.
features.admin-mode on Admin mode - Whoever is in admin mode gets their inventory back right away.
features.teleport on Teleport to players - Teleport to players: in the player menu and with /mradmin tp.
features.summon on Summon players - Summon a player to you (player menu).
features.inventory on View inventory - View a player's inventory and ender chest - read only.
features.freeze on Freeze - Freeze players. Switching it off frees frozen players right away.
features.server-status on Server status - Server status: /mradmin status and the server tile in the dashboard.
features.tickets on Tickets & reports - Tickets and reports: /report for players, /mradmin tickets for the team.
features.staff-chat on Staff chat (/sc) - Staff chat with /sc - only the team reads it.

Other plugins

MRadmin detects them by itself. Off = do not connect, even if the plugin is installed.

Setting Default Meaning
integrations.mrsleep on MRsleep - Work together with MRsleep (button in the dashboard, info in the player menu). Off = do not connect, even if MRsleep is installed.
integrations.mrchunks on MRchunks - Work together with MRchunks (chunk loaders in the dashboard and server status, conspicuous loaders). Off = do not connect.
integrations.mrtoolbar on MRtoolbar - Work together with MRtoolbar (view a player's tool belt). Off = do not connect.
integrations.mrpvp on MRpvp - Work together with MRpvp (duels in the dashboard and on the player page). Off = do not connect.
integrations.libertybans on LibertyBans - Punishments on the player page of the web interface. LibertyBans' permissions apply.
libertybans.durations 1h, 1d, 7d, 30d, perm Quick choices ban/mute - E.g. 1h, 7d - "perm" = forever.

Updates of MRadmin

Notice about new versions in the console and on joining.

Setting Default Meaning
updates.enabled on Look for updates - Look for new versions of MRadmin and tell the team. Installing works under Server → Plugins.
updates.source GitHub (github) Source - Where to look for new versions: GitHub releases (default) or Modrinth.
updates.include-prereleases off Pre-releases too - Also report pre-releases. If a 0.x runs, they are always reported.
updates.interval-hours 6 hours Check every - This often a new version is looked for.
updates.notify-on-join on Tell the team on join - Players with mradmin.admin.update get a notice.

The menus in game.

Setting Default Meaning
gui.refresh-ticks 20 ticks Refresh every - 20 ticks = 1 second.
gui.sounds on Click sounds - Click sounds in the menus in game.

Starter & planned restarts

The starter (mrserver) starts the server, brings it back after restarts, crashes and hangs and keeps Paper up to date. Set it up with /mradmin starter setup. Without the starter only the planned restarts apply.

Setting Default Meaning
server.memory-min 1G Memory min. - E.g. 1G or 4096M - from the next start on.
server.memory-max 4G Memory max. - E.g. 4G - from the next start on.
server.java-flags -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=30 -XX:G1MaxNewSizePercent=40 -XX:G1HeapRegionSize=8M -XX:G1ReservePercent=20 -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=15 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 -Dusing.aikars.flags=https://mcflags.emc.gs -Daikars.new.flags=true Java options - Tuning options only (e.g. Aikar's flags). Anything that starts programs or reads and writes files is ignored.
server.paper-update On every start (auto) Paper updates - Only builds of the same Minecraft version, never a new Minecraft version. If a new build does not start, the starter uses the old one again.
server.restart-times empty Daily restart at - Times like 05:00 (time zone from General). The countdown starts before.
server.countdown 15m Countdown - For planned restarts and mrserver stop/restart without a time, at most 1h.
server.plain-stop Server stays down (stop) After /stop - What a plain /stop (console or game) does with the starter: the server stays down, or it restarts.
server.discord-announce off Countdown in the community Discord - Also announce restarts and stops in the community channel (discord-announce). The team log always gets them, with the reason.
server.crashes.max 3 Give up after crashes - After this many crashes ...
server.crashes.window-minutes 15 minutes within - ... within this time the starter gives up and the server stays down until someone looks.
server.hang-seconds 180 seconds Hang after - That long without a tick, then the starter ends and starts the server. 0 = off.
server.stop-timeout-seconds 180 seconds Shutdown at most - Shutting down may take this long, then the starter ends the server.

Waiting room

Behind a proxy (Velocity): during restarts, stops and maintenance players wait on a second server with MRwaitroom and come back by themselves afterwards.

Setting Default Meaning
waiting-room.enabled off Use the waiting room - Sends players to the waiting room on restarts, stops and maintenance instead of kicking them. Needs Velocity with bungee-plugin-message-channel = true and a second server with MRwaitroom.
waiting-room.server waitroom Name in the proxy - Exactly the name the waiting room has in the section [servers] of velocity.toml (e.g. waitroom). MRadmin sends the players there.
waiting-room.on-restart on On restart and stop - At the end of every countdown (browser, /mradmin restart|stop, planned restarts) all players move to the waiting room right before the server goes down and come back by themselves afterwards.
waiting-room.on-maintenance on During maintenance - During a maintenance whoever may not stay on the server (rights below) waits in the waiting room (with end and title of the maintenance) instead of being kicked. Whoever does not move over is kicked as usual after 5 seconds.
waiting-room.rights Admin: On the server during maintenance admin-mode · Visit the waiting room admin-mode · Stay in the waiting room admin-mode · Admin mode in the waiting room always
Staff: On the server during maintenance never · Visit the waiting room never · Stay in the waiting room never · Admin mode in the waiting room never
Supporter: On the server during maintenance never · Visit the waiting room never · Stay in the waiting room never · Admin mode in the waiting room never
Rights per role - What every team role may do (highest of mradmin.groups.admin, staff, support). Normal players may do none of it. “Only in admin mode”: an admin without admin mode is treated like a player. On restarts everyone always moves over. The waiting room gets this table from here.
waiting-room.link.bind 127.0.0.1 Address - Internal address of this machine in the LAN, e.g. 10.0.0.5 - never a public one. The waiting room asks about restarts, maintenance and warnings there and picks up configuration and updates. Empty = no connection (the waiting room then only sees whether the server is up).
waiting-room.link.port 8126 Port - Own port of the waiting room connection, not the one of the web interface. Must be reachable from the waiting room (firewall).
waiting-room.link.key empty Key - Shared key - the same value goes into the config.yml of the waiting room (main.link-key). Created on the first start. After 10 wrong tries per minute MRadmin blocks.
waiting-room.agent-url empty Address of the waiting room - Where MRadmin reads performance, console and log of the waiting room server (its section agent), e.g. http://10.0.0.6:8127. Empty = automatic: the address its reports come from with the port it reports.

Plugins & restart

The page Plugins: updates from the official releases, installed on the next restart.

Setting Default Meaning
versions.enabled on Page Plugins - Page Server → Plugins with all MRtechnology plugins, updates and installing.
versions.check-interval-hours 6 hours Look for updates every - This often GitHub is asked for new versions.
versions.auto-download Off (off) Download by itself - Download new versions by itself: off, hotfixes only (1.2.x), new features (1.x) or all. Installed on the next restart.
versions.channel Stable (stable) Default channel - Which releases the plugins get. Per plugin on the page Server - Plugins, there also dev. Back to stable never downgrades.
versions.dev-token empty Dev channel release token - From the developer. Only with it the channel dev can be chosen per plugin (unfinished builds). Keep it secret.
versions.restart-method No button (none) Restart button - A server does not start itself - stop only if a script, watchdog or panel starts it again.
versions.restart-delays 15m, 30m, 60m Countdown choices - Normal restarts, e.g. 15m, 30m, 60m (players should get at least 15 minutes warning).
versions.emergency-delays 5m, 1m, now Emergency countdown - Short times in the red emergency area (only with a reason) - e.g. 5m, 1m, now.

Server health

TPS, MSPT, CPU and memory every second - in the web interface under Health.

Setting Default Meaning
health.history 7 days (7d) Keep the history - How long the history is kept: 24h, 7d or 30d. The last hour per second, older values as 5-minute averages.
health.alert.enabled on Warning on lag - To the team in game and to the Discord log - with an all-clear afterwards.
health.alert.below-tps 15 TPS Warn below - Warn (team in game, Discord log and push notification) when the TPS fall below this ...
health.alert.minutes 5 minutes That long below - ... for this long in a row. Short hiccups do not cause a warning.

Storage

Where tickets, maintenance and web accounts are kept. Takes effect after a restart; on the first start with SQLite or MySQL the YAML data is taken over.

Setting Default Meaning
storage.type Files (YAML) (yaml) Storage type - Where tickets, maintenance and web accounts are kept: files, SQLite (one file, recommended for the web interface) or MySQL/MariaDB. When switching, the data is taken over on the next start. (needs a restart)
storage.mysql.host localhost Host - Address of the database server, e.g. localhost or 10.0.0.5. (needs a restart)
storage.mysql.port 3306 Port - Port of the database server (MySQL/MariaDB usually 3306). (needs a restart)
storage.mysql.database mradmin Database - Name of the database. It must already exist. (needs a restart)
storage.mysql.username empty User - User of the database. (needs a restart)
storage.mysql.password empty Password - Password of the database user. Never shown in the browser. (needs a restart)
storage.mysql.pool-size 4 Simultaneous connections - MRadmin keeps this many connections to the database open at once. (needs a restart)
storage.server-id main Name of this server - Only relevant if several servers share one database. (needs a restart)
storage.table-prefix mradmin_ Table prefix - Put before every table name (e.g. mradmin_tickets) - in case the database is also used for other things. (needs a restart)

Log

All events of MRadmin and the plugins (like in the Discord log) and the actions in the web interface - page Log.

Setting Default Meaning
logging.keep-days 14 days Keep - This many days the entries of the page Log are kept (1-14).

Team notices

New tickets, applications, crashes, updates ... in the inbox, as push and in the game. Each team member chooses in their account what they get and how.

Setting Default Meaning
notifications.disabled empty Off for everyone - These kinds go to nobody - neither inbox nor push nor game.

Tickets & reports

/report for all players. Own categories are added in the file (tickets.categories).

Setting Default Meaning
tickets.cooldown 60s Wait between tickets - None for the team.
tickets.reply-cooldown 3s Wait between messages - Minimum time between two messages of a player in the same ticket (against spam).
tickets.max-open-per-player 3 Open tickets per player - At most this many open tickets per player, all categories together.
tickets.min-subject-length 3 characters Subject at least - Minimum length of the subject (player reports have no subject).
tickets.max-subject-length 50 characters Subject at most - Maximum length of the subject - the form does not allow more.
tickets.min-text-length 10 characters Text at least - Minimum length of the description of a new ticket.
tickets.max-text-length 500 characters Text at most - Maximum length of the texts - the form does not allow more.
tickets.notify-creator on Tell the player on closing - Let the player know when the team closes their ticket (if online). New replies are always reported, when offline on the next join.
tickets.show-staff-names on Show team names - Off = players only see "Team".
tickets.team-icon NETHER_STAR Picture for the team - Item name, e.g. NETHER_STAR.
tickets.auto-claim on First to answer takes over - Whoever from the team answers first takes over the ticket - further messages of the player then only go to them while online.
tickets.shown-messages 20 Messages shown - The ticket shows this many of the latest messages, older ones are hidden.
tickets.sound BLOCK_NOTE_BLOCK_PLING Sound for new tickets - Empty = no sound.
tickets.keep-closed 7d Keep closed ones - Closed tickets are kept this long (also visible to the player), then deleted.
tickets.plugin-reports on Automatic tickets from plugins - E.g. MRchunks on a lag lock - the player can explain there what happened.
tickets.icon NAME_TAG Icon of the tickets - Icon of all tickets in the menus, as an item name (e.g. NAME_TAG).
tickets.categories Cheating: Name · Player report `true`<br>Chat: Name · Player report true
Griefing: Name · Player report `true`<br>Scam: Name · Player report true
Bug: Name · Player report `false`<br>Other: Name · Player report false
Categories - Empty name = text from the language file. Player report = pick a player first. Empty permission = everyone.

Admin mode

Inventory and position are saved, you only get the admin menu item. Own dashboard buttons are in the file (admin-mode.menu.buttons).

Setting Default Meaning
admin-mode.gamemode Creative (CREATIVE) Game mode - Menus cannot be clicked in spectator mode.
admin-mode.return-to-start on Back to the starting point - When admin mode ends, go back to where it started.
admin-mode.compass-material STRUCTURE_VOID Item of the admin menu - Do not use the compass - WorldEdit teleports with it.
admin-mode.compass-slot 4 Hotbar slot - 0 to 8.
admin-mode.prevent-drop on No dropping - No dropping items in admin mode - protects against creative items in survival.
admin-mode.prevent-pickup on No picking up - No picking up items in admin mode.
admin-mode.end-on-quit off End on leaving - Off = it continues in admin mode on the next join.

Announcements

Look of /mradmin announce. Own presets are made in the web interface under Communication.

Setting Default Meaning
announce.fade-in 0.5 seconds Fade in - How long the title of an announcement fades in.
announce.stay 6 seconds Stay - How long the title stays on screen.
announce.fade-out 1 seconds Fade out - How long the title fades out.
announce.chat on In the chat too - Also write the announcement into the chat.
announce.sound BLOCK_NOTE_BLOCK_BELL Sound - Empty = no sound.
announce.volume 1 Volume - Volume of the sound (0 to 1, above that it is heard further away).
announce.pitch 1 Pitch - Pitch of the sound (0.5 low to 2 high, 1 = normal).

Maintenance

During maintenance only players with mradmin.maintenance.bypass can join.

Setting Default Meaning
maintenance.warn-before 15m Boss bar from - The boss bar with countdown appears this long before the start.
maintenance.bossbar.enabled on Boss bar - Boss bar with a countdown before the start (everyone) and the remaining time during maintenance (team only).
maintenance.bossbar.color Yellow (YELLOW) Colour - Colour of the boss bar before the start.
maintenance.bossbar.final-color Red (RED) Colour shortly before the start - In the last seconds before the start the boss bar changes to this colour.
maintenance.bossbar.final-seconds 60 seconds Shortly before means - How many seconds before the start the colour changes.
maintenance.bossbar.overlay 10 parts (NOTCHED_10) Segments - A continuous bar or split into 6, 10, 12 or 20 segments.
maintenance.bossbar.show-during-maintenance on Remaining time for the team - During maintenance a boss bar with the remaining time (if the end is known).
maintenance.bossbar.during-color Purple (PURPLE) Colour during maintenance - Colour of the boss bar during maintenance (only the team sees it).
maintenance.reminders 15m, 10m, 5m, 2m, 1m, 30s Reminders in the chat - A message this long before the start each.
maintenance.title-countdown-seconds 10 seconds Big countdown from - Countdown in the middle of the screen, 0 = off.
maintenance.sound BLOCK_NOTE_BLOCK_PLING Sound - Bukkit name, e.g. BLOCK_NOTE_BLOCK_PLING. Empty = no sound.
maintenance.kick-on-start on Kick at the start - Players without bypass are kicked from the server.
maintenance.kick-delay-seconds 5 seconds Kick after - Players without access are kicked this many seconds after the start - time to still read the message.
maintenance.motd.enabled on Own MOTD in the server list - During maintenance the server list shows the text maintenance-motd from the language file instead of the normal MOTD.
maintenance.motd.replace-version on "Maintenance" instead of the player count - Instead of the player count, Maintenance appears on the right of the server list in red (text maintenance-version-text).

Uptime Kuma

MRadmin logs in to Uptime Kuma and follows the maintenance windows live.

Setting Default Meaning
uptime-kuma.enabled off Maintenance from Uptime Kuma - Take over planned maintenance from Uptime Kuma (needs address and login). For incidents of status pages the address is enough.
uptime-kuma.url empty Address - E.g. https://status.yourserver.com - also needed for the incidents of the status pages.
uptime-kuma.username empty Username - User for the login to Uptime Kuma (or a token instead).
uptime-kuma.password empty Password - Password of the user above. Never shown in the browser.
uptime-kuma.token empty Token instead of password - Needed with 2FA: log in to Kuma in the browser, F12 → Local Storage → value of "token".
uptime-kuma.monitor-ids empty Monitor IDs - Maintenance affecting one of these monitors. Both lists empty = every maintenance.
uptime-kuma.maintenance-ids empty Maintenance IDs - Exactly these maintenance windows.
uptime-kuma.refresh-seconds 60 seconds Fetch the list again every - Changes arrive right away; to be safe the whole list is also fetched again this often.
uptime-kuma.reconnect-seconds 30 seconds Reconnect after - After a lost connection, wait this long and connect again.
uptime-kuma.keep-schedule-when-offline on Keep the schedule when Kuma is gone - If Kuma cannot be reached, the last known schedule stays valid (on) or is discarded (off).
uptime-kuma.status-pages empty Status pages for incidents - Slugs, e.g. main for /status/main. Pinned incidents show on the player page and in game. Only needs the address.
uptime-kuma.incidents on Take over incidents - Show incidents pinned on the status pages (e.g. during an outage) as a warning on the player page and in game.
uptime-kuma.incident-seconds 15 seconds Read incidents every - How often the status pages are read for incidents.

Web interface

The built-in web server only listens locally - reachable through your reverse proxy with HTTPS. Changes restart the web server.

Setting Default Meaning
web.enabled off Web interface on - Off also switches this page off - back only through the file.
web.bind 127.0.0.1 Address of the web server - Only change if the proxy runs on another machine (then e.g. 0.0.0.0 + firewall).
web.port 8125 Port - Port of the built-in web server. Your reverse proxy forwards to it.
web.public-url empty Public address - E.g. https://admin.yourserver.com - for links, sign-in, passkeys and the player page.
web.trusted-proxies 127.0.0.1 Trusted proxies - MRadmin only trusts these for the real visitor IP (X-Forwarded-For). Single addresses or ranges, e.g. 172.16.0.0/12 for a proxy in Docker.
web.login.require-2fa off Require 2FA for the team - The team additionally needs 2FA (code from an app) for the administration. Otherwise an own sign-in (password, passkey or Discord) is enough.
web.login.passkeys on Sign-in with passkey - Sign in with fingerprint, Face ID, Windows Hello or a password manager. Only works under the public address.
web.login.password on Sign-in with password - With the player name or a confirmed e-mail address - with a code from the app if 2FA is on.
web.login.discord.enabled off Sign-in with Discord - Create a Discord application, add the redirect <public-url>/api/discord/callback.
web.login.discord.client-id empty Discord client ID - Client ID of your Discord application (developer portal) for Sign in with Discord.
web.login.discord.client-secret empty Discord client secret - Client secret of the same Discord application. Never shown in the browser.
web.item-icons on Item pictures - Load the textures once from the official Minecraft client (about 40 MB). Off = short labels instead of pictures.
web.legal.imprint-url empty Imprint link - Empty = text from plugins/MRadmin/web/impressum.md.
web.legal.privacy-url empty Privacy link - Empty = text from plugins/MRadmin/web/datenschutz.md.
web.push.contact empty Contact for push - mailto:you@yourserver.com or an https address. Empty = public-url. Apple needs a valid contact.
web.privacy.audit-retention 90d Keep the log - Delete entries in the web interface's log (with IP addresses) automatically after this time.
web.privacy.mask-ip off Shorten IP addresses - 1.2.3.4 → 1.2.3.0 in the log and for the devices.

Web console

Console output on the page Log and commands in the browser (page Console). Before opening the console, the page asks for the code from the app.

Setting Default Meaning
web.console.enabled on Web console on - Page Console in the browser: read the server output and run commands (admins only, after unlocking with a fresh code).
web.console.unlock-minutes 15 minutes Stay open after the code - The console stays unlocked this long after the code (per device).
web.console.lines 1000 Lines kept - MRadmin keeps this many of the newest lines for the console.
web.console.blocked op, deop, stop, restart, reload, lp, luckperms, perm, perms, permissions, pex, mradmin web, whitelist off, save-off Blocked commands - Never work through the web console - not even hidden in execute … run.
web.console.hide-links on Hide links - Hide links in the output (e.g. setup links).
web.console.hide-ips on Hide IP addresses - Hide IP addresses in the output (e.g. on join).

Appearance

Name, colour and footer of the web interface - with preview and logo upload under Server → Appearance.

Setting Default Meaning
branding.name empty Name of the server - Instead of "MRadmin" in the browser tab, sign-in, bar, mails, 2FA app and passkeys. Empty = text mail-server-name.
branding.tagline empty Tagline - Short line under the name on the sign-in page.
branding.accent #2f6fed Accent colour - Buttons and highlights; the text colour on it is chosen by the page.
branding.footer-text empty Footer text - On the page and in the mails. Empty = none.
branding.links Link 1: Label · Address
Link 2: Label · Address
Link 3: Label · Address
Link 4: Label · Address
Footer links - Up to 4 links, e.g. Discord, website, rules. Without a label or address a link is not shown.

Player page

Every player gets their own page under <public-url>/me - sign-in with the code from /web.

Setting Default Meaning
player-web.enabled off Player page on - Needs the web interface and the public address.
player-web.session-days 14 days Signed in at most - A browser stays signed in at most this long after the code from /web. Then the page asks for a new code - the bookmark keeps working.
player-web.idle-days 7 days Sign out after unused - ... and is signed out earlier if the page was not opened for this long.
player-web.code-seconds 120 seconds Code works for - The 6-digit code from /web works this long - and only once.
player-web.max-devices 5 Devices per player - At most this many browsers per player. Signing in one more signs out the one unused the longest.
player-web.rankings.enabled on Rankings - Tab Statistics with server rankings (Minecraft statistics and the plugins' rankings). Players can opt out.
player-web.rankings.top 10 Places per ranking - This many places per ranking. The viewer's own place is shown in addition if it is further down.
player-web.rankings.statistics play-time, xp-level, blocks-mined, blocks-placed, items-crafted, mob-kills, deaths, totems, distance, distance-swum, distance-flown, jumps, fish-caught, times-slept Statistics in the rankings - Which Minecraft statistics appear as rankings, in this order. Empty = only the plugins' rankings.
player-web.personal-stats play-time, blocks-mined, mob-kills, deaths Own statistics on the start page - In this order - the first one big. None = no tile.
player-web.news.enabled on Slideshow on the start page - Slideshow on the start page of the player page: warnings, maintenance, restart, plugin notices, ticket answers and newest posts.
player-web.news.seconds 8 seconds Per slide - 0 = only by hand.
player-web.news.show-maintenance on Show planned maintenance - Show a planned or running maintenance in the slideshow.
player-web.news.show-restart on Show a planned restart - Show a planned restart (countdown) in the slideshow.
player-web.news.show-plugin-notices on Show notices of the plugins - E.g. MRchunks: loader locked or over the budget.
player-web.news.show-tickets on Show ticket answers - Show own tickets with a new, unread answer of the team (or closed) in the slideshow.
player-web.news.chat-preview.enabled on News as a preview in the chat - Once per player with a link to the whole post.
player-web.news.chat-preview.max 3 At most at once - At most this many posts at once as a preview in the chat.
player-web.news.chat-preview.max-age-days 14 days Not older than - Older posts no longer come into the chat as a preview.
player-web.news.alerts.chat on Critical warnings in the chat - Critical warnings to everyone online in the chat; whoever joins while one is active gets it too.
player-web.news.alerts.title on Critical warnings as a title - Critical warnings also as a title on the screen.

Public forms

Unban requests and contact form - reachable without signing in, they end up as tickets with you.

Setting Default Meaning
web.requests.unban.enabled on Unban requests - Under <public-url>/entbannung (needs LibertyBans).
web.requests.unban.kick-message on Address and code in the ban message - Append the address and code for the unban request to LibertyBans' ban message (text unban-kick).
web.requests.contact.enabled on Contact form - Public contact form at /kontakt - requests arrive as a ticket.
web.requests.application.enabled off Whitelist application - Visitors apply on the start page (widget) or at /bewerben with name, Minecraft name and e-mail. After confirming by mail the application arrives as a ticket. Needs mail.
web.requests.application.server-address empty Server address in the acceptance mail - e.g. play.example.com - empty = see the website.
web.requests.notify-by-mail on Replies by mail too - If an address was given and mail is set up.
web.requests.min-text-length 20 characters Text at least - Minimum length of the message (justification, appeal, contact request).
web.requests.max-text-length 3000 characters Text at most - Maximum length of the message.
web.requests.spam.per-ip-per-hour 5 Requests per IP and hour - At most this many requests per IP address and hour.
web.requests.spam.max-open-contact 50 At most open contact requests - If this many contact requests are open, the form takes no new ones until some are closed.
web.requests.spam.proof-of-work 16 Calculation against spam - 0 = off, 16 = about one second on a phone, every +1 doubles.

Sending mail

For replies to unban requests and contact requests. Test: /mradmin mail test <address>.

Setting Default Meaning
mail.enabled off Send mail - Send mail for replies to unban and contact requests. Without mail, requesters see replies via their status link. Test: /mradmin mail test.
mail.host empty SMTP server - Address of your SMTP server, e.g. smtp.example.com.
mail.security STARTTLS (587) (starttls) Encryption - SSL (usually port 465), STARTTLS (usually 587) or none (only for a mail server on the same machine).
mail.port 587 Port - Port of the SMTP server - matching the encryption.
mail.username empty User - User for the login to the SMTP server.
mail.password empty Password - Many providers need a separate app password.
mail.from empty Sender - Sender address, e.g. noreply@example.com - your mail server has to allow it.
mail.from-name MRadmin Sender name - Name the recipient sees as the sender.
mail.reply-to empty Reply to - Empty = to the sender. What arrives there does not end up in the ticket.

Map

The map of the player page. squaremap only renders the pictures - MRadmin installs, updates and sets it up by itself.

Setting Default Meaning
map.enabled on Map on - Map on the player page (tab Map) and in /mradmin map. squaremap renders the pictures.
map.auto-configure on Set up squaremap by itself - On every start. Values changed by hand stay.
map.hide-module-worlds on Hide the worlds of plugins - E.g. MRpvp's arena world.
map.squaremap.auto-install on Install squaremap by itself - Install squaremap by itself if missing: official release from Modrinth, only with a matching SHA-512 checksum. Active after the next restart.
map.squaremap.auto-update on Update squaremap by itself - Download new squaremap versions into plugins/update/ - Paper installs them on the next restart.
map.squaremap.full-render on Redraw everything after installing - After installing or updating, render all worlds once completely (in the background), so the pictures match the new version.
map.squaremap.check-hours 12 hours Look for squaremap updates every - This often MRadmin asks Modrinth for new squaremap versions.
map.nether-roof.enabled on Nether ceiling as its own map - The Nether ceiling (bedrock and everything built on it) as its own map - squaremap only shows the Nether from inside.
map.nether-roof.from-y 128 On the ceiling from height - From this height a player counts as on the ceiling and the map switches there (the bedrock ceiling ends at 127).
map.nether-roof.full-render on Draw the ceiling once completely - Draw the ceiling once completely (all generated chunks). After that, changes are added when chunks load.
map.nether-roof.chunks-per-second 40 chunks/s Drawing speed - Lower it if the server gets slower meanwhile.
map.player-page.open-at-player on Open at the player - Open the map where the player stands (if online). A link to a spot wins.
map.player-page.follow on Button "Follow me" - Button Follow me: the map keeps the player in the middle while walking (only online).
map.player-page.chunk-grid on Layer chunk grid - Layer Chunk grid with lines along the chunk borders - each player switches it on themselves.
map.player-page.players.self on See oneself - The player sees themselves on the map (head with viewing direction).
map.player-page.players.others on See other players - Also needs mradmin.map.players. Off e.g. for a manhunt.
map.player-page.players.update-seconds 1 seconds Update positions every - This often the positions are updated while the map is open (1-60 seconds).
map.player-page.players.hide-admin-mode on Hide admin mode - Others never see players in admin mode on the map.
map.player-page.players.hide-spectators on Hide spectators - Others never see players in spectator mode on the map.
map.player-page.players.hide-invisible on Hide invisible players - Others never see invisible players on the map.
map.player-page.players.hidden-worlds empty Worlds without other players - Keys like minecraft:the_nether.
map.player-page.players.allow-hide on Players may hide themselves - Whoever hides sees no one else either.

Discord log (team)

Events to a team channel. Webhook: Edit channel → Integrations → Webhooks → New webhook → copy URL.

Setting Default Meaning
discord.enabled off Send Discord log - Post MRadmin's events (maintenance, tickets, restarts, crashes …) to a team channel via webhook. The log always has them.
discord.webhook-url empty Webhook URL - Webhook of the team channel (channel settings → integrations → webhooks). Never shown in the browser.
discord.username MRadmin Name in the channel - Name the messages appear under in the channel.
discord.avatar-url empty Avatar URL - Picture for the messages (address of a PNG/JPG file). Empty = picture of the webhook.
discord.use-embeds on Coloured embeds - Messages as coloured cards (colour per event). Off = plain text.
discord.footer Minecraft-Server Footer - Small text under every card, e.g. the server name.
discord.events Maintenance scheduled: Send true · Colour #F1C40F
Maintenance changed: Send true · Colour #3498DB
Maintenance cancelled: Send true · Colour #95A5A6
Maintenance starts: Send true · Colour #E74C3C
Maintenance ends: Send true · Colour #2ECC71
Kuma connected: Send false · Colour #2ECC71
Kuma disconnected: Send true · Colour #E67E22
Announcement: Send true · Colour #9B59B6
Admin mode on: Send true · Colour #E67E22
Admin mode off: Send true · Colour #1ABC9C
Alert of a plugin: Send true · Colour #E74C3C
Reloaded: Send true · Colour #3498DB
New ticket: Send true · Colour #E67E22
Ticket message: Send false · Colour #3498DB
Ticket closed: Send true · Colour #2ECC71
Ticket reopened: Send true · Colour #F1C40F
Player frozen: Send true · Colour #3498DB
Player unfrozen: Send true · Colour #95A5A6
Player kicked: Send true · Colour #E67E22
Left while frozen: Send true · Colour #E74C3C
Staff chat: Send false · Colour #7F8C8D
Web sign-in: Send true · Colour #3498DB
Web account set up: Send true · Colour #9B59B6
Command in the web console: Send true · Colour #E74C3C
Server lags: Send true · Colour #E74C3C
Server recovered: Send true · Colour #2ECC71
Waiting room lags: Send true · Colour #E74C3C
Waiting room recovered: Send true · Colour #2ECC71
Update downloaded: Send true · Colour #3498DB
Restart planned: Send true · Colour #E67E22
Restart cancelled: Send true · Colour #95A5A6
Planned restarts paused: Send true · Colour #95A5A6
Planned restarts on again: Send true · Colour #95A5A6
Stop planned: Send true · Colour #E67E22
Stop cancelled: Send true · Colour #95A5A6
Server crashed (starter): Send true · Colour #E74C3C
Server hung (starter): Send true · Colour #E74C3C
Starter gave up: Send true · Colour #992D22
Paper updated: Send true · Colour #3498DB
Paper build rolled back: Send true · Colour #E67E22
Events - Which events go to the channel and in which colour.

Discord announcements (community)

Own webhook for the public channel - sparing: one message per maintenance that is edited.

Setting Default Meaning
discord-announce.enabled off Send announcements - Public announcements (maintenance, announcements, news, warnings) via an own webhook into a community channel - separate from the team log.
discord-announce.webhook-url empty Webhook URL - Webhook of the community channel. Never shown in the browser.
discord-announce.username empty Name in the channel - Name the announcements appear under. Empty = name of the webhook.
discord-announce.avatar-url empty Avatar URL - Picture for the announcements. Empty = picture of the webhook.
discord-announce.footer empty Footer - Small text under every announcement.
discord-announce.ping-role-id empty Role to mention (ID) - Developer mode on, right-click the role → copy ID. Empty = nobody.
discord-announce.maintenance.enabled on Post maintenance - Post every maintenance as one message that is kept up to date: scheduled → running → ended or cancelled (edited instead of posted again).
discord-announce.maintenance.announce-ahead 24h At the earliest before - Only post once the maintenance is at most this far away - prevents recurring maintenance from appearing long before.
discord-announce.maintenance.min-length 0 Do not post shorter ones - 0 = post all.
discord-announce.maintenance.ping on Mention on maintenance - Mention the role in the first post of a maintenance (never in the later edits).
discord-announce.maintenance.debounce-seconds 60 seconds Combine changes - Combine quick changes (times, titles) into one edit. Start and end come right away.
discord-announce.announcements.enabled on Post announcements - Post announcements: presets with a Discord text automatically (except with -q), own texts only with -d.
discord-announce.announcements.cooldown 10m Same preset at most every - Post the same preset at most once within this time (e.g. a restart countdown = one post).
discord-announce.announcements.ping off Mention on announcements - Mention the role with announcements.
discord-announce.news.ping off Mention on news - Mention the role with news and changelogs.
discord-announce.alerts.ping on Mention on critical warnings - Mention the role with critical warnings.
discord-announce.kuma.enabled on Post incidents from Kuma - Post incidents from Uptime Kuma; when they change, the message is edited, at the end it says Resolved.
discord-announce.kuma.ping on Mention on red incidents - Mention the role only with red (danger) incidents.
discord-announce.colors.scheduled #F1C40F Colour: scheduled - Card colour of a planned maintenance.
discord-announce.colors.started #E74C3C Colour: started - Card colour of a running maintenance.
discord-announce.colors.ended #2ECC71 Colour: ended - Card colour of an ended maintenance.
discord-announce.colors.cancelled #95A5A6 Colour: cancelled - Card colour of a cancelled maintenance.
discord-announce.colors.announce #9B59B6 Colour: announcement - Card colour of announcements.
discord-announce.colors.news #3498DB Colour: news - Card colour of news.
discord-announce.colors.changelog #2ECC71 Colour: changelog - Card colour of changelogs.
discord-announce.colors.alert #E74C3C Colour: warning - Card colour of critical warnings.

Generated automatically from src/main/resources/web-config.yml + config.yml.

✎ Edit on GitHub·docs/wiki/en/konfiguration.md ↗·View unreleased state