Skip to content

Commit d7dbcb4

Browse files
committed
Update JDBC driver requirements in configuration files
- Added detailed instructions for required JDBC drivers in Config.yml and bungeeconfig.yml. - Clarified default ports for MySQL/MariaDB and PostgreSQL. - Included notes on driver installation and usage examples for better clarity.
1 parent f37a067 commit d7dbcb4

2 files changed

Lines changed: 52 additions & 12 deletions

File tree

VotingPlugin/src/main/resources/Config.yml

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,12 +97,25 @@
9797
# Valid Options:
9898
# - SQLITE
9999
# - MYSQL
100+
#
101+
# If using MYSQL:
102+
# - You MUST have a compatible JDBC driver present on the server.
103+
# - MySQL: com.mysql.cj.jdbc.Driver
104+
# - MariaDB: org.mariadb.jdbc.Driver
105+
# - PostgreSQL: org.postgresql.Driver
106+
#
107+
# NOTE:
108+
# If your server does not already provide these drivers, you can install this jar:
109+
# https://bencodez.com/job/MySQLDriver/
110+
# It bundles MySQL, MariaDB, and PostgreSQL drivers together.
111+
#
112+
# Only install the driver jar if your platform does not already include one.
100113
DataStorage: SQLITE
101114

102115
# Information for MySQL storage
103116
Database:
104117
Host: ''
105-
# Default port is 3306
118+
# Default port is 3306 (MySQL/MariaDB) or 5432 (PostgreSQL)
106119
Port: 3306
107120
Database: ''
108121
Username: ''
@@ -127,12 +140,19 @@ Database:
127140
# - MYSQL
128141
# - MARIADB
129142
# - POSTGRESQL
143+
#
144+
# IMPORTANT:
145+
# A matching JDBC driver for the selected DbType MUST be installed.
146+
# If the driver is missing, the plugin will fail to connect.
130147
DbType: MYSQL
131148

132-
#Driver: '' # Optional custom driver class name
133-
134-
# OUTDATED OPTIONS - kept for backwards compatibility
135-
# UseMariaDB: false # Attempt to use MariaDB driver instead of MySQL (set DbType instead)
149+
# Optional custom driver class name.
150+
# If set, this driver MUST exist on the classpath or the connection will fail.
151+
# Example:
152+
# Driver: 'com.mysql.cj.jdbc.Driver'
153+
# Driver: 'org.mariadb.jdbc.Driver'
154+
# Driver: 'org.postgresql.Driver'
155+
#Driver: ''
136156

137157
# --- Connection / lifecycle tuning ---
138158
# MaxLifeTime: -1 # ms; <=0 uses plugin's safe default (e.g., 25m)
@@ -151,6 +171,7 @@ Database:
151171
# PoolName: 'VotingPlugin-Hikari'
152172

153173

174+
154175
###########################################
155176
# Basic Settings
156177
# General plugin behavior and defaults

VotingPlugin/src/main/resources/bungeeconfig.yml

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,23 @@
6868
# Set bungeecoord to true on servers on the network (In VotingPlugin)
6969
# Set server name in each server related to what it is on bungee
7070
#
71-
# MYSQL Required on all setups
71+
# MYSQL IS REQUIRED on all proxy/network setups.
72+
# A compatible JDBC driver MUST be installed.
73+
#
74+
# Supported drivers:
75+
# - MySQL: com.mysql.cj.jdbc.Driver
76+
# - MariaDB: org.mariadb.jdbc.Driver
77+
# - PostgreSQL: org.postgresql.Driver
78+
#
79+
# NOTE:
80+
# If your platform does not already include these drivers,
81+
# you can install this jar which bundles all three:
82+
# https://bencodez.com/job/MySQLDriver/
83+
#
7284
# MYSQL INFO --------------------------
7385
Database:
7486
Host: ''
75-
# Default port is 3306
87+
# Default port is 3306 (MySQL/MariaDB) or 5432 (PostgreSQL)
7688
Port: 3306
7789
Database: ''
7890
Username: ''
@@ -93,17 +105,23 @@ Database:
93105
# - MYSQL
94106
# - MARIADB
95107
# - POSTGRESQL
108+
#
109+
# IMPORTANT:
110+
# A matching JDBC driver for the selected DbType MUST be installed
111+
# or the plugin will fail to connect.
96112
DbType: MYSQL
97113

98-
#Driver: '' # Optional custom driver class name
99-
100-
# OUTDATED OPTIONS - kept for backwards compatibility
101-
# UseMariaDB: false # Attempt to use MariaDB driver instead of MySQL (set DbType instead)
114+
# Optional custom driver class name.
115+
# If set, this driver MUST exist on the classpath or the connection will fail.
116+
# Example:
117+
# Driver: 'com.mysql.cj.jdbc.Driver'
118+
# Driver: 'org.mariadb.jdbc.Driver'
119+
# Driver: 'org.postgresql.Driver'
120+
#Driver: ''
102121

103122
# --- Driver / security options ---
104123
# UseSSL: false
105124
# PublicKeyRetrieval: false # Needed on some MySQL setups with caching_sha2_password
106-
# UseMariaDB: false # Attempt to use MariaDB driver instead of MySQL
107125

108126
# --- Connection / lifecycle tuning ---
109127
# MaxLifeTime: -1 # ms; <=0 uses plugin's safe default (e.g., 25m)
@@ -121,6 +139,7 @@ Database:
121139
# Optional pool name (useful if you run multiple DB pools)
122140
# PoolName: 'VotingPlugin-Hikari'
123141

142+
124143
####################################################################################
125144
# Global mysql data handle for between server commmunications
126145
# This is NOT required for proxy voting to work

0 commit comments

Comments
 (0)