Skip to content

Wiki and config description are not equal #169

Description

@Akorian

Description

I deployed a fresh MC server using paper 1.20.8 a few days ago and today I checked stuff in the wiki and noticed that content is not equal.

The description for messaging-service which is quite extensive contains nats which is not present on the wikipage. And the value none is not not present in the local config file.

I talked to @/nojokefna on discord who asked me to create this issue :)

Proposed Behavior

Make the content of the file and the wiki the same.

# Define which messaging service should be used by the plugin.
#
# - If enabled and configured, LuckPerms will use the messaging service to inform other connected
#   servers of changes.
# - Use the command "/lp networksync" to manually push changes.
# - Data is NOT stored using this service. It is only used as a messaging platform.
#
# - If you decide to enable this feature, you should set "sync-minutes" to -1, as there is no need
#   for LuckPerms to poll the database for changes.
#
# - Possible options:
#   => sql       Uses the SQL database to form a queue system for communication. Will only work when
#                'storage-method' is set to MySQL or MariaDB. This is chosen by default if the
#                option is set to 'auto' and SQL storage is in use. Set to 'notsql' to disable this.
#   => pluginmsg Uses the plugin messaging channels to communicate with the proxy.
#                LuckPerms must be installed on your proxy & all connected servers backend servers.
#                Won't work if you have more than one proxy.
#   => lilypad   Uses LilyPad pub-sub to push changes. You need to have the LilyPad-Connect plugin
#                installed.
#   => redis     Uses Redis pub-sub to push changes. Your server connection info must be configured
#                below.
#   => rabbitmq  Uses RabbitMQ pub-sub to push changes. Your server connection info must be
#                configured below.
#   => nats      Uses Nats pub-sub to push changes. Your server connection info must be
#                configured below.
#   => custom    Uses a messaging service provided using the LuckPerms API.
#   => auto      Attempts to automatically setup a messaging service using redis or sql.
messaging-service: none

vs https://luckperms.net/wiki/Configuration#messaging-service

Settings for the messaging service.

If enabled and configured, LuckPerms will use the messaging system to inform other connected servers of changes. Use the command "/luckperms networksync" to push changes. Data is NOT stored using this service. It is only used as a messaging platform.

If you decide to enable this feature, you should set "sync-minutes" to -1, as there is no need for LuckPerms to poll the database for changes.

Available options:

    sql - uses the SQL database to form a queue system for communication. Will only work when storage-method is set to MySQL or MariaDB. This is chosen by default when the option is set to 'none' and SQL storage is in use. Set to notsql to disable this.
    pluginmsg - uses the plugin messaging channels to communicate. LuckPerms must be installed on your BungeeCord/Velocity proxy & all connected backend servers. This won't work if you have multiple proxies. The option needs to be set on all LP instances. Using sql is recommended over this option!
    lilypad - uses LilyPad's pub sub to push changes. You need to have the LilyPad-Connect plugin installed.
    redis - uses Redis pub sub to push changes.
    rabbitmq - uses RabbitMQ pub sub (AMQP) to push changes.
    none - nothing!

Extra Details

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions