MySQL database for plugins: LuckPerms, CoreProtect and more

Most plugins store their data in files in their own folder. For large amounts of data (block history in CoreProtect) or for sharing data between several servers (LuckPerms permissions on a network behind a proxy), a MySQL database works better. This guide shows how to create one at StormHost, how to connect LuckPerms and CoreProtect to it and how to access it from your computer.

When to use MySQL instead of files#

Creating a database#

1. In the customer area, open My services, click your Minecraft server and go to the Database tab.

2. Type a short name in the Database name field, for example luckperms. Letters without accents, digits and underscores are allowed, up to 48 characters.

3. Leave the Allowed connections from field at % (see below).

4. Click Create database.

   The new database appears in the list with the Host, User, Allowed connections from and Password details.

Other buttons:

• New password – generates a new password. The old one stops working, so enter the new one right away in the configuration of every plugin that uses the database, and restart the server.
• Delete – deletes the database along with all its data.

The number of databases depends on your plan. Above the list you'll see Used 1 of 10. When the limit is used up, you'll see The limit has been reached. Several plugins can share one database – each uses its own tables with its own prefix (LuckPerms luckperms_, CoreProtect co_).

LuckPerms#

1. Stop the server.

2. In the Files tab, open plugins/LuckPerms/config.yml.

3. Find storage-method and the data section and change them:

   storage-method: mysql
   
   data:
     address: <HOST>
     database: <DATABASE_NAME>
     username: <USER>
     password: '<PASSWORD>'

   Replace <HOST>, <DATABASE_NAME>, <USER> and <PASSWORD> with the details from the Database tab, always without the angle brackets. Keep the single quotes around the password.

4. Save the file (Ctrl+S) and start the server.

Moving existing permissions to MySQL#

If you already have permissions in the original storage, move them over:

1. Before changing storage-method, type this in the console:

   lp export zaloha-opravneni

   • lp export – saves all LuckPerms data to a file.
   • zaloha-opravneni – the file name. This creates plugins/LuckPerms/zaloha-opravneni.json.gz.

2. Stop the server, change config.yml as described above and start the server.

3. Type this in the console:

   lp import zaloha-opravneni.json.gz

   Type the file name including the .json.gz extension. The data is loaded into the new database.

CoreProtect#

1. Stop the server.

2. In the Files tab, open plugins/CoreProtect/config.yml and change:

   use-mysql: true
   table-prefix: co_
   mysql-host: <ADDRESS>
   mysql-port: <PORT>
   mysql-database: <DATABASE_NAME>
   mysql-username: <USER>
   mysql-password: '<PASSWORD>'

   Split the Host value from the Database tab: the part before the colon goes into <ADDRESS>, the number after the colon into <PORT>.

3. Save and start the server.

Newer CoreProtect versions (version 25 and later) have a database-type key instead of use-mysql. If you see it in the file, set database-type: mysql – it takes priority over use-mysql.

Other plugins#

Configurations differ, but the fields are almost always the same:

Always restart the server after making changes. The /reload command often breaks plugins that use a database.

Access from your computer#

You can browse and edit the database on your computer. This works if Allowed connections from is set to %.

mariadb -h <ADDRESS> -P <PORT> -u <USER> -p <DATABASE_NAME>

Database backups#

Backups in the Backups tab only contain the server's files, not the databases. Export them separately:

1. Connect to the database in HeidiSQL (see above).
2. Click the database on the left and choose Tools › Export database as SQL.
3. Tick both table creation and data, choose output to a .sql file and click Export.

To restore: in HeidiSQL, select the database and choose File › Run SQL file. LuckPerms also has its own backup with the lp export <FILE_NAME> command.

Verification#

• LuckPerms: type lp info in the console. The Storage section must show Type: MySQL (or MariaDB).
• CoreProtect: type co status in the console. You'll see the line Database: Using MySQL.
• In HeidiSQL or DBeaver, you'll see new tables in the database (luckperms_…, co_…).

Troubleshooting#

Communications link failure or Unable to connect to MySQL server.#

The plugin couldn't reach the database at all (the second message comes from CoreProtect). Check the address and port (the Host value, exactly, including the number after the colon). In CoreProtect, the address and port have to be in separate fields. If everything is correct, the database server may be temporarily unavailable – try again in a moment, or contact support.

Access denied for user '…'@'…' (using password: YES)#

The database rejected the user name or password:

• You changed the password with the New password button in the meantime and the plugin still has the old one.
• The password contains special characters and isn't in quotes.
• Allowed connections from contains a specific IP address the server doesn't connect from. Create a new database with %.

Unknown database '…'#

The database name doesn't match. Copy it exactly from the Database tab, including any prefix.

Warning: Establishing SSL connection without server's identity verification is not recommended#

This is a warning from the MySQL driver. For LuckPerms, add useSSL: false and verifyServerCertificate: false to data.pool-settings.properties; for other plugins, look for a useSSL option.

Connection is not available, request timed out after 5000ms#

LuckPerms didn't get a connection from its pool. The database is unavailable, or the connection limit has been reached. Each server with LuckPerms keeps 10 connections by default – if more than that point at the database (a server network, other plugins), lower maximum-pool-size.

No operations allowed after connection closed#

The database closed an idle connection before the plugin renewed it. In LuckPerms, maximum-lifetime (in milliseconds) must be shorter than the database's timeout. The default of 30 minutes usually works.

Further reading#

• LuckPerms: storage types (opens in a new window)
• LuckPerms: switching storage types (opens in a new window)
• LuckPerms: storage system errors (opens in a new window)
• CoreProtect: configuration (opens in a new window)
• HeidiSQL: help (opens in a new window)