Redis Configuration

Overview

When running multiple proxy instances (BungeeCord, Velocity, etc.), Redis enables automatic synchronization of maintenance status and whitelisted players across all connected proxies. This eliminates the need to manually update each proxy when making changes.

Why Use Redis?

Without Redis, each proxy instance maintains its own independent state:

Enabling maintenance on one proxy doesn’t affect others
Whitelisted players must be added to each proxy separately
Server-specific maintenance settings aren’t synchronized

With Redis enabled:

All proxies share the same maintenance status (global and per-server)
Whitelist changes are instantly synchronized across all proxies
Configuration changes propagate automatically

boolean

default:"false"

Enables Redis synchronization across multiple proxy instances.

Note the typo in the config key: enables instead of enabled. This is the actual key used in config.yml.

string

default:"redis://localhost:6379"

Redis connection URI. Must be properly formatted according to the Redis URI specification.

Ensure your Redis instance is properly secured with authentication and network restrictions.

Configuration Example

redis:
  enables: true
  uri: "redis://localhost:6379"

URI Format

The Redis URI follows this format:

redis[s]://[[username][:password]@][host][:port][/db-number]

URI Components

Component	Description	Required	Example
Protocol	`redis://` for standard connection, `rediss://` for SSL/TLS	Yes	`redis://` or `rediss://`
Username	Redis ACL username (Redis 6.0+)	No	`myuser`
Password	Redis authentication password	No	`mypassword`
Host	Redis server hostname or IP address	Yes	`localhost`, `redis.example.com`
Port	Redis server port	No (defaults to 6379)	`6379`
Database	Redis database number	No (defaults to 0)	`0`, `1`, `2`

URI Examples

Basic Local Connection

redis:
  enables: true
  uri: "redis://localhost:6379"

Password-Protected Redis

redis:
  enables: true
  uri: "redis://:mypassword@localhost:6379"

SSL/TLS Connection with Authentication

redis:
  enables: true
  uri: "rediss://user:password@redis.example.com:6380"

Remote Redis with Custom Database

redis:
  enables: true
  uri: "redis://:password@10.0.0.100:6379/2"

Redis 6.0+ with ACL Username

redis:
  enables: true
  uri: "redis://maintenance-user:secure-password@localhost:6379/0"

Setting Up Redis

1. Install Redis

Ubuntu/Debian

sudo apt update
sudo apt install redis-server

CentOS/RHEL

sudo yum install redis

Docker

docker run -d --name redis -p 6379:6379 redis:latest

2. Secure Redis

Never expose Redis to the public internet without proper security measures. An unsecured Redis instance can be exploited.

Edit your Redis configuration file (usually /etc/redis/redis.conf):

# Set a strong password
requirepass your-strong-password-here

# Bind to specific IP addresses only
bind 127.0.0.1 10.0.0.100

# Disable dangerous commands
rename-command FLUSHDB ""
rename-command FLUSHALL ""
rename-command CONFIG ""

Restart Redis after making changes:

sudo systemctl restart redis

3. Configure Network Access

If your proxies are on different servers, configure firewall rules to allow Redis access:

# Allow Redis port from specific IP addresses
sudo ufw allow from 10.0.0.10 to any port 6379
sudo ufw allow from 10.0.0.11 to any port 6379

4. Update Plugin Configuration

On each proxy instance, update the configuration:

redis:
  enables: true
  uri: "redis://:your-strong-password-here@10.0.0.100:6379"

5. Reload Plugin

Reload the plugin on each proxy:

/maintenance reload

What Gets Synchronized

When Redis is enabled, the following data is synchronized across all proxy instances:

Global Maintenance Status

# Enable maintenance on one proxy
/maintenance on

# All proxies instantly reflect maintenance mode

Server-Specific Maintenance

# Enable maintenance on specific server
/maintenance on server1

# All proxies know server1 is in maintenance

Whitelisted Players

# Add player on proxy 1
/maintenance add PlayerName

# PlayerName can now join through any proxy

Timer State

Active timers are synchronized:

# Start timer on proxy 1
/maintenance endtimer 1h

# All proxies show the same countdown

Multi-Proxy Setup Example

Let’s say you have 3 proxy instances:

Proxy 1: proxy1.example.com (10.0.0.10)
Proxy 2: proxy2.example.com (10.0.0.11)
Proxy 3: proxy3.example.com (10.0.0.12)
Redis Server: redis.example.com (10.0.0.100)