Documentation/configuration/General

The general section of the config.yml file is primarily configuration settings that didn't seem to make sense anywhere else because they weren't specific to any one feature. For reference, here is a link to the Default/Blank config.yml. The section this page is talking about is at the beginning. It starts off with:

general:
# Log level controls the degree of detail that is sent to the console/log
# The possible settings are (in order of quietest to noisiest:

Log Level

This is setting gives you control over how much "noise" CommunityBridge generates in your log.

  • For day-to-day operation, I recommend a log-level of info. On info, only basic informational messages, warnings of possible problems, and errors will be sent to your log by CommunityBridge.
  • During configuration I recommend setting your log-level to config. This will give you more detailed information, including the configuration settings that CommunityBridge read from the config.yml.
  • If you want to see the notifications that the synchronize events and reminder events have occurred, set log level to fine.
  • If you're having problems getting the config to work or you're trying to troubleshoot a possible error, I recommend setting log-level to all. This will be very noisy, it includes every MySQL query that CommunityBridge performs. If you're tracking down an error that you can repeat at will, it is a good idea to set the log-level to all, repeat the error and then set it back to info. You can then paste the resulting section of your log into a issue report on CommunityBridge's issue system.

Plugin Metrics

I strongly recommend setting this to true and making sure that the opt-out setting in PluginMetrics/config.yml is set to false. To see my views on why, read this page: Why Plugin Metrics?

plugin-metrics: true

Auto Settings

auto-every-unit: minutes

This setting controls what unit you want to use to specify how long between synchronizations and reminders. This affects ALL features that take an amount of time as a configuration option. I recommend setting it to minutes, but it does support: ticks, seconds, minutes, hours, days.

auto-sync: true

This setting set to true turns on the automatic synchronization. If this setting is turned off, then synchronization of groups and statistics will only occur when a player connects or disconnects.

auto-sync-every: 20

This setting controls how long between synchronizations. It uses the "auto every unit" above. So if you set auto-every-unit to minutes and set this setting to 20, automatic synchronization will occur every 20 minutes. It is recommended that synchronization be no more frequent than fifteen minutes to keep the load on the server down.

sync-during-join: true
sync-during-quit: true

These two settings control whether or not a statistics and group synchronization is run when the player joins or quits the server. Disabling these may reduce load on your server, but will create delays for players getting their new rank/group synchronized. It also reduces the effectiveness of the statistics synchronization, since the best time to update the players statistics is when they quit.

Application URL

<<code yaml>>application-url:<</yaml>> This setting is used in some of the messages displayed to the user. It should be set to the URL of your web application, forums, etc.

Permissions System

permissions-system:

If you're using either unregistered/registered group assignment or you are using any of the group synchronization features, you'll need to tell CommunityBridge which permissions system you are using. As of this writing, the options are: bPerms, GroupManager, PermsBukkit, PEX.

A special note if you're using GroupManager. GroupManager will not create groups on the fly. So any groups you specify in the linking or synchronization sections must already exist. That is, you need to have used mangadd <groupname>. Also, GroupManager announces primary group changes with no option to override this behavior.


Comments

Posts Quoted:
Reply
Clear All Quotes