Skip to main content

Maintenance mode for your Minecraft server

The most customizable free maintenance plugin supporting Paper, BungeeCord, Velocity, and Sponge. Control server access with custom MOTDs, timers, and whitelist management.

Get StartedAPI Reference

Quick start

Get Maintenance running on your server in minutes

1

Download the plugin

Download the latest version for your platform from Hangar.
Download maintenance-paper-<version>.jar for Paper 1.20.1+
2

Install and start your server

Place the downloaded JAR file in your server’s plugins folder and restart your server. The plugin will generate default configuration files on first startup.
# Paper/Spigot
/plugins/Maintenance.jar

# BungeeCord
/plugins/Maintenance.jar

# Velocity
/plugins/Maintenance.jar
3

Configure maintenance mode

Edit the generated config.yml in your plugin’s folder to customize messages, timers, and behavior.
config.yml
# Enable maintenance mode
maintenance-enabled: false

# Custom maintenance message
ping-message:
  enabled: true
  messages:
    - "<red>Currently under maintenance<br><gradient:#fbffc2:#0fffff>We will be back soon!"
Changes require a reload: /maintenance reload
4

Enable maintenance mode

Use the command to toggle maintenance mode on or off:
/maintenance on
Players not on the whitelist will be prevented from joining. Add players to the whitelist with:
/maintenance add <player>

Explore by topic

Everything you need to customize and manage maintenance mode

Configuration

Customize messages, timers, and maintenance behavior

Commands

Complete command reference with examples

Permissions

Control who can manage maintenance mode

Platform Guides

Platform-specific setup for Paper, Bungee, Velocity, and Sponge

API Integration

Integrate Maintenance into your own plugins

Features

Advanced features like proxy mode and Redis sync

Key features

Everything you need for professional server maintenance

Custom MOTDs & Icons

Display custom messages and server icons during maintenance. Supports MiniMessage formatting with gradients and colors.

Timers & Scheduling

Schedule automatic maintenance start and end times with broadcast notifications. Timers persist across server restarts.

Whitelist Management

Grant specific players access during maintenance. Whitelist persists across servers with Redis synchronization.

Proxy Networks

Enable maintenance on individual backend servers or globally. Redis support for multi-proxy synchronization.

Resources

Get help and connect with the community

GitHub Repository

View source code, report issues, and contribute

Discord Community

Get support and discuss with other users

Hangar Downloads

Download the latest releases for all platforms

Crowdin Translations

Help translate Maintenance into your language

Ready to get started?

Install Maintenance on your server in minutes and take full control of your server’s maintenance mode.

Install Now