From 979c80d9eeabd45b107401c119f77cf0e3a3081f Mon Sep 17 00:00:00 2001 From: Luck Date: Tue, 15 Jun 2021 20:41:36 +0100 Subject: [PATCH] Clarify config comments for mongodb-connection-uri option (#3062) --- bukkit/src/main/resources/config.yml | 18 ++++++++++++++---- bungee/src/main/resources/config.yml | 18 ++++++++++++++---- fabric/src/main/resources/luckperms.conf | 18 ++++++++++++++---- nukkit/src/main/resources/config.yml | 18 ++++++++++++++---- sponge/src/main/resources/luckperms.conf | 18 ++++++++++++++---- velocity/src/main/resources/config.yml | 18 ++++++++++++++---- 6 files changed, 84 insertions(+), 24 deletions(-) diff --git a/bukkit/src/main/resources/config.yml b/bukkit/src/main/resources/config.yml index 7fc20df99..3dd7fa872 100644 --- a/bukkit/src/main/resources/config.yml +++ b/bukkit/src/main/resources/config.yml @@ -154,15 +154,25 @@ data: #verifyServerCertificate: false # The prefix for all LuckPerms SQL tables. + # + # - This only applies for remote SQL storage types (MySQL, MariaDB, etc). # - Change this if you want to use different tables for different servers. table-prefix: 'luckperms_' - # The prefix to use for all LuckPerms collections. Change this if you want to use different - # collections for different servers. The default is no prefix. + # The prefix to use for all LuckPerms MongoDB collections. + # + # - This only applies for the MongoDB storage type. + # - Change this if you want to use different collections for different servers. The default is no + # prefix. mongodb-collection-prefix: '' - # MongoDB ClientConnectionURI for use with replica sets and custom connection options - # - See https://docs.mongodb.com/manual/reference/connection-string/ + # The connection string URI to use to connect to the MongoDB instance. + # + # - When configured, this setting will override anything defined in the address, database, + # username or password fields above. + # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it + # below. + # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/ mongodb-connection-uri: '' # Define settings for a "split" storage setup. diff --git a/bungee/src/main/resources/config.yml b/bungee/src/main/resources/config.yml index 27d5655f5..1b93a0d78 100644 --- a/bungee/src/main/resources/config.yml +++ b/bungee/src/main/resources/config.yml @@ -151,15 +151,25 @@ data: #verifyServerCertificate: false # The prefix for all LuckPerms SQL tables. + # + # - This only applies for remote SQL storage types (MySQL, MariaDB, etc). # - Change this if you want to use different tables for different servers. table-prefix: 'luckperms_' - # The prefix to use for all LuckPerms collections. Change this if you want to use different - # collections for different servers. The default is no prefix. + # The prefix to use for all LuckPerms MongoDB collections. + # + # - This only applies for the MongoDB storage type. + # - Change this if you want to use different collections for different servers. The default is no + # prefix. mongodb-collection-prefix: '' - # MongoDB ClientConnectionURI for use with replica sets and custom connection options - # - See https://docs.mongodb.com/manual/reference/connection-string/ + # The connection string URI to use to connect to the MongoDB instance. + # + # - When configured, this setting will override anything defined in the address, database, + # username or password fields above. + # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it + # below. + # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/ mongodb-connection-uri: '' # Define settings for a "split" storage setup. diff --git a/fabric/src/main/resources/luckperms.conf b/fabric/src/main/resources/luckperms.conf index fe8b50d12..3b03682a7 100644 --- a/fabric/src/main/resources/luckperms.conf +++ b/fabric/src/main/resources/luckperms.conf @@ -156,15 +156,25 @@ data { } # The prefix for all LuckPerms SQL tables. + # + # - This only applies for remote SQL storage types (MySQL, MariaDB, etc). # - Change this if you want to use different tables for different servers. table-prefix = "luckperms_" - # The prefix to use for all LuckPerms collections. Change this if you want to use different - # collections for different servers. The default is no prefix. + # The prefix to use for all LuckPerms MongoDB collections. + # + # - This only applies for the MongoDB storage type. + # - Change this if you want to use different collections for different servers. The default is no + # prefix. mongodb-collection-prefix = "" - # MongoDB ClientConnectionURI for use with replica sets and custom connection options - # - See https://docs.mongodb.com/manual/reference/connection-string/ + # The connection string URI to use to connect to the MongoDB instance. + # + # - When configured, this setting will override anything defined in the address, database, + # username or password fields above. + # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it + # below. + # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/ mongodb-connection-uri = "" } diff --git a/nukkit/src/main/resources/config.yml b/nukkit/src/main/resources/config.yml index efd7686ff..574ebed59 100644 --- a/nukkit/src/main/resources/config.yml +++ b/nukkit/src/main/resources/config.yml @@ -154,15 +154,25 @@ data: #verifyServerCertificate: false # The prefix for all LuckPerms SQL tables. + # + # - This only applies for remote SQL storage types (MySQL, MariaDB, etc). # - Change this if you want to use different tables for different servers. table-prefix: 'luckperms_' - # The prefix to use for all LuckPerms collections. Change this if you want to use different - # collections for different servers. The default is no prefix. + # The prefix to use for all LuckPerms MongoDB collections. + # + # - This only applies for the MongoDB storage type. + # - Change this if you want to use different collections for different servers. The default is no + # prefix. mongodb-collection-prefix: '' - # MongoDB ClientConnectionURI for use with replica sets and custom connection options - # - See https://docs.mongodb.com/manual/reference/connection-string/ + # The connection string URI to use to connect to the MongoDB instance. + # + # - When configured, this setting will override anything defined in the address, database, + # username or password fields above. + # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it + # below. + # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/ mongodb-connection-uri: '' # Define settings for a "split" storage setup. diff --git a/sponge/src/main/resources/luckperms.conf b/sponge/src/main/resources/luckperms.conf index 26c596ba6..764cac2f8 100644 --- a/sponge/src/main/resources/luckperms.conf +++ b/sponge/src/main/resources/luckperms.conf @@ -156,15 +156,25 @@ data { } # The prefix for all LuckPerms SQL tables. + # + # - This only applies for remote SQL storage types (MySQL, MariaDB, etc). # - Change this if you want to use different tables for different servers. table-prefix = "luckperms_" - # The prefix to use for all LuckPerms collections. Change this if you want to use different - # collections for different servers. The default is no prefix. + # The prefix to use for all LuckPerms MongoDB collections. + # + # - This only applies for the MongoDB storage type. + # - Change this if you want to use different collections for different servers. The default is no + # prefix. mongodb-collection-prefix = "" - # MongoDB ClientConnectionURI for use with replica sets and custom connection options - # - See https://docs.mongodb.com/manual/reference/connection-string/ + # The connection string URI to use to connect to the MongoDB instance. + # + # - When configured, this setting will override anything defined in the address, database, + # username or password fields above. + # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it + # below. + # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/ mongodb-connection-uri = "" } diff --git a/velocity/src/main/resources/config.yml b/velocity/src/main/resources/config.yml index 382476b8d..56f8799a3 100644 --- a/velocity/src/main/resources/config.yml +++ b/velocity/src/main/resources/config.yml @@ -144,15 +144,25 @@ data: #verifyServerCertificate: false # The prefix for all LuckPerms SQL tables. + # + # - This only applies for remote SQL storage types (MySQL, MariaDB, etc). # - Change this if you want to use different tables for different servers. table-prefix: 'luckperms_' - # The prefix to use for all LuckPerms collections. Change this if you want to use different - # collections for different servers. The default is no prefix. + # The prefix to use for all LuckPerms MongoDB collections. + # + # - This only applies for the MongoDB storage type. + # - Change this if you want to use different collections for different servers. The default is no + # prefix. mongodb-collection-prefix: '' - # MongoDB ClientConnectionURI for use with replica sets and custom connection options - # - See https://docs.mongodb.com/manual/reference/connection-string/ + # The connection string URI to use to connect to the MongoDB instance. + # + # - When configured, this setting will override anything defined in the address, database, + # username or password fields above. + # - If you have a connection string that starts with 'mongodb://' or 'mongodb+srv://', enter it + # below. + # - For more information, please see https://docs.mongodb.com/manual/reference/connection-string/ mongodb-connection-uri: '' # Define settings for a "split" storage setup.