OlaPermissions

Configuration Guide

OlaPermissions is designed to be plug-and-play for single servers, but incredibly powerful for large networks.

The server-name Context

In your configuration file, you will find server-name: "global". If you are running a single standalone server, you can ignore this. If you are running a BungeeCord or Velocity network, you should change this to match the server's backend name (e.g., survival, creative, lobby). This allows you to assign permissions that only work on specific servers!

• Example: /ola user Notch group add VIP 0 survival will give Notch the VIP rank, but only when he is logged into the survival server.

Database Types

You have two choices for your database:

1. SQLITE: (Default). This is a flat-file database stored directly in the plugins/OlaPermissions/ folder. It requires absolutely zero setup. Perfect for single servers.
2. MARIADB: If you are running a network of servers, you must use MariaDB (or MySQL). This centralizes all your users and groups into one remote database so that your entire network shares the same permissions.

Redis Synchronization

If you use MariaDB across a proxy network, you should also enable Redis. Without Redis, if an admin on lobby types /ola user Notch group add VIP, the survival server won't know about it until it re-polls the database or restarts. By enabling Redis, the lobby server will instantly broadcast a high-speed ping to survival, telling it to update Notch's permissions instantly.

redis:
  enabled: true
  host: "127.0.0.1"
  port: 6379
  password: "super_secret_password"