Installation

RequirementsCopy Anchor Link

• zAuctionHouse V4 on all servers
• Redis server (6.0+ recommended)
• MySQL/MariaDB database (shared between all servers)

Step 1: Install RedisCopy Anchor Link

If you don't have a Redis server, you can install one:

Ubuntu/Debian:

sudo apt update
sudo apt install redis-server
sudo systemctl enable redis-server
sudo systemctl start redis-server

Docker:

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

Many hosting providers also offer managed Redis instances.

Step 2: Configure zAuctionHouseCopy Anchor Link

Ensure all servers use the same MySQL database:

storage-type: 'MYSQL'
server-name: 'skyblock'
database-configuration:
  table-prefix: 'zauctionhouse_'
  host: '192.168.10.10'
  port: 3306
  user: 'homestead'
  password: 'secret'
  database: 'zauctionhouse'
  debug: false

Step 3: Install the Redis AddonCopy Anchor Link

1. Download zAuctionHouseRedis from your purchase
2. Place zAuctionHouseRedis.jar in the plugins folder of each server
3. Start each server to generate the configuration

Step 4: Configure Redis ConnectionCopy Anchor Link

Edit plugins/zAuctionHouseRedis/config.yml on each server:

redis-config:
  mode: 'standalone'
  host: '192.168.10.10'
  port: 6379
  user: ''
  password: ''
  channel-name: 'zauctionhouse'
  database: 0
  timeout: 2000
  lock-ttl-seconds: 30
  pool:
    max-total: 64
    max-idle: 32
    min-idle: 16

Redis Sentinel ModeCopy Anchor Link

For high-availability setups, zAuctionHouse Redis supports Redis Sentinel. Sentinel provides automatic master discovery and failover, so if the master goes down, a replica is automatically promoted and the plugin reconnects transparently.

To use Sentinel mode, set mode to sentinel and configure the sentinel section:

redis-config:
  mode: 'sentinel'

  sentinel:
    master-name: 'mymaster'
    user: ''
    password: ''
    nodes:
      - '192.168.10.10:26379'
      - '192.168.10.11:26379'
      - '192.168.10.12:26379'

  user: ''
  password: ''
  channel-name: 'zauctionhouse'
  database: 0
  timeout: 2000
  lock-ttl-seconds: 30
  pool:
    max-total: 64
    max-idle: 32
    min-idle: 16

Step 5: Restart ServersCopy Anchor Link

Restart all servers. The plugin will automatically:

• Connect to your Redis server
• Subscribe to auction events
• Synchronize data between servers

VerificationCopy Anchor Link

To verify the addon is working:

1. Check the console for successful Redis connection message
2. List an item on Server 1
3. Open /ah on Server 2 - the item should appear immediately
4. Purchase the item on Server 2
5. Check Server 1 - the item should be removed from the listing