RedisBungee/RedisBungee-API/src/main/resources/config.yml

143 lines
5.0 KiB
YAML
Raw Normal View History

2022-04-13 18:26:36 +00:00
# RedisBungee configuration file.
2024-04-21 12:00:03 +00:00
# Notice:
# Redis 7.2.4 is last free and open source Redis version after license change
# https://download.redis.io/releases/redis-7.2.4.tar.gz which you have to compile yourself,
# unless your package manager still provide it.
# Here is The alternatives
# - 'ValKey' By linux foundation https://valkey.io/download/
# - 'KeyDB' by Snapchat inc https://docs.keydb.dev/docs/download/
2024-04-22 12:27:14 +00:00
# The 'Redis', 'ValKey', 'KeyDB' server you will use.
2023-04-15 17:29:06 +00:00
# these settings are ignored when cluster mode is enabled.
redis-server: 127.0.0.1
redis-port: 6379
2022-07-16 12:32:10 +00:00
# Cluster Mode
# enabling this option will enable cluster mode.
2022-07-15 23:00:51 +00:00
cluster-mode-enabled: false
2022-04-13 18:26:36 +00:00
# FORMAT:
# redis-cluster-servers:
2024-04-22 12:27:14 +00:00
# - host: 127.0.0.1`
# port: 2020
# - host: 127.0.0.1
# port: 2021
# - host: 127.0.0.1
# port: 2021
# you can set single server and Jedis will automatically discover cluster nodes,
# but might fail if this single redis node is down when Proxy startup, its recommended put the all the nodes
redis-cluster-servers:
- host: 127.0.0.1
port: 6379
# OPTIONAL: if your redis uses acl usernames set the username here. leave empty for no username.
redis-username: ""
2023-10-18 11:50:47 +00:00
# OPTIONAL but recommended: If your Redis server uses AUTH, set the required password.
2022-04-13 18:26:36 +00:00
redis-password: ""
2022-04-13 18:26:36 +00:00
# Maximum connections that will be maintained to the Redis server.
# The default is 10. This setting should be left as-is unless you have some wildly
# inefficient plugins or a lot of players.
max-redis-connections: 10
2023-10-18 11:50:47 +00:00
# since redis can support ssl by version 6 you can use SSL/TLS in redis bungee too!
2022-04-13 18:26:36 +00:00
# but there is more configuration needed to work see https://github.com/ProxioDev/RedisBungee/issues/18
# Keep note that SSL/TLS connections will decrease redis performance so use it when needed.
2022-04-13 18:26:36 +00:00
useSSL: false
2024-04-21 12:00:03 +00:00
# An identifier for this network, which helps to separate redisbungee instances on same redis instance.
# You can use environment variable 'REDISBUNGEE_NETWORK_ID' to override
network-id: "main"
# An identifier for this BungeeCord / Velocity instance. Will randomly generate if leaving it blank.
2024-04-21 12:00:03 +00:00
# You can set Environment variable 'REDISBUNGEE_PROXY_ID' to override
proxy-id: "proxy-1"
2023-10-18 11:50:47 +00:00
# since RedisBungee Internally now uses JedisPooled instead of Jedis, JedisPool.
2022-07-25 16:04:21 +00:00
# which will break compatibility with old plugins that uses RedisBungee JedisPool
2023-09-14 06:34:41 +00:00
# so to mitigate this issue, RedisBungee will create an JedisPool for compatibility reasons.
# disabled by default
2024-04-18 08:48:00 +00:00
# Automatically disabled when cluster mode is enabled
enable-jedis-pool-compatibility: false
# max connections for the compatibility pool
compatibility-max-connections: 3
2022-07-25 16:04:21 +00:00
# restore old login behavior before 0.9.0 update
# enabled by default
# when true: when player login and there is old player with same uuid it will get disconnected as result and new player will log in
# when false: when a player login but login will fail because old player is still connected.
kick-when-online: true
# enabled by default
# this option tells RedisBungee handle motd and set online count, when motd is requested
# you can disable this when you want to handle motd yourself, use RedisBungee api to get total players when needed :)
handle-motd: true
# A list of IP addresses for which RedisBungee will not modify the response for, useful for automatic
# restart scripts.
2024-04-18 08:48:00 +00:00
# Automatically disabled if handle-motd is disabled.
exempt-ip-addresses: []
# disabled by default
# RedisBungee will attempt to connect player to last server that was stored.
reconnect-to-last-server: false
2024-04-18 08:48:00 +00:00
# For redis bungee legacy commands
# either can be run using '/rbl glist' for example
# or if 'install' is set to true '/glist' can be used.
# 'install' also overrides the proxy installed commands
#
# In legacy commands each command got it own permissions since they had it own permission pre new command system,
# so it's also applied to subcommands in '/rbl'.
commands:
# Permission redisbungee.legacy.use
redisbungee-legacy:
enabled: false
subcommands:
# Permission redisbungee.command.glist
glist:
enabled: false
install: false
# Permission redisbungee.command.find
find:
enabled: false
install: false
# Permission redisbungee.command.lastseen
lastseen:
enabled: false
install: false
# Permission redisbungee.command.ip
ip:
enabled: false
install: false
# Permission redisbungee.command.pproxy
pproxy:
enabled: false
install: false
# Permission redisbungee.command.sendtoall
sendtoall:
enabled: false
install: false
# Permission redisbungee.command.serverid
serverid:
enabled: false
install: false
# Permission redisbungee.command.serverids
serverids:
enabled: false
install: false
# Permission redisbungee.command.plist
plist:
enabled: false
install: false
# Permission redisbungee.command.use
redisbungee:
enabled: true
# Config version DO NOT CHANGE!!!!
2024-02-23 19:06:58 +00:00
config-version: 2