How to install LuckPerms on your Minecraft server

LuckPerms manages permission groups and the commands players can use. A single server can keep its permissions locally. A shared database is useful for a network, but linking several servers takes more than selecting the database option on one of them.

Use automatic configuration

1. Back up the server and stop it. Open Plugins for Paper/Spigot-style software or a proxy, or Mods for a supported mod loader.
2. Keep Versions on Current version, search for LuckPerms and choose a compatible release. When Configure automatically is offered, leave it ticked.
3. Choose Local storage for an H2 database in the server files, or Managed database for MySQL. The panel reuses this installation's database first, otherwise an existing server database, and only creates one if needed and permitted. There isn't a database picker in this installer.
4. Click Install plugin or Install mod, then start the server. For an installation tracked by the panel, you can reopen these choices through its Change version icon.

   

If no compatible download or automatic option is listed, use the manual method. Switching storage doesn't transfer existing permissions. Export and migrate them using LuckPerms' storage guidance before changing an established server.

Install and configure LuckPerms manually

1. Choose your server platform on the official LuckPerms download page. A Bukkit/Paper JAR, Velocity JAR and Fabric JAR aren't interchangeable.
2. With the server stopped, open Files in the panel and open plugins. Drag the JAR into File Manager, or use SFTP to upload it to the same folder. Use mods for Fabric, Forge or NeoForge and install the dependencies required by that build. Start the server once, then stop it to edit the generated config.
3. For Paper, Spigot and Bukkit, open plugins/LuckPerms/config.yml. Velocity uses plugins/luckperms/config.yml; modded and Sponge builds use config/luckperms/luckperms.conf.
4. For local H2 storage in a YAML config, keep this setting

   storage-method: h2

   

   For MySQL, create a database from the panel and copy its connection details into the existing data section. For example

   storage-method: mysql
   data:
     address: 'YOUR_DATABASE_HOST:3306'
     database: 'YOUR_DATABASE_NAME'
     username: 'YOUR_DATABASE_USERNAME'
     password: 'YOUR_DATABASE_PASSWORD'

   Use the database host and port from Databases. Keep other entries in the file and replace each example value. A HOCON .conf file uses different syntax

   storage-method = "mysql"
   data {
     address = "YOUR_DATABASE_HOST:3306"
     database = "YOUR_DATABASE_NAME"
     username = "YOUR_DATABASE_USERNAME"
     password = "YOUR_DATABASE_PASSWORD"
   }

   For local H2 in that file, use storage-method = "h2".
5. Save and start the server. Run lp info in the Bukkit/Paper console to confirm LuckPerms loaded with the expected storage. In game, use /lp info.

For permissions shared across several servers, follow LuckPerms' network installation guide. Each server needs the intended shared storage and messaging configuration. The panel's automatic setup only configures the server you're installing on.