diff --git a/Config.md b/Config.md index b1529e4..3630ac1 100644 --- a/Config.md +++ b/Config.md @@ -2,6 +2,8 @@ The example config has enough pre-configuration for you to be able to get the gist of what is going on, but if you need extra help, here is a list of all configurable options. This list may not always be up to date but the example configuration will be. +Settings are referred to by Mercury in a manner such as `config.irc.server` or `config.errorhandling.error_channel`. Each of the headers below before groups of options are the same but lowercase and with spaces removed in the code itself. + All options must be configured at this stage, so if you are unsure what values to input or change, leave them as default (you must change irc.server & irc.channels at a minimum). IRC @@ -17,6 +19,8 @@ IRC | realname | Real Name | git.supernets.org/hgw/mercury | | autorejoin | Auto Rejoin if bot is disconnected (this does not include crashes, Docker will handle auto-restarts in that case) | true/false | | prefix | Client command prefix | Anything I suppose, default is m! | +| settings_auth_enable | Require authorisation to edit settings with m!opt operset | true/false | +| settings_auth_hostmask | Admin hostmask, this user can use m!opt operset to edit options in default.json if settings_auth_enabled is true | ~user@supernets.org | Flood Protection @@ -33,6 +37,7 @@ Error Handling | error_logging | Toggling sending console errors to IRC | true/false | | error_channel | Channel to send console errors to | #channel | | error_channel_pass | Password for the nominated error_channel, if it exists, leave this variable blank if not | Channel Password | +| validity_override | Bypass config validity checking during initialisation, this allows the bot to start with a bare minimum config file. This may have unintended side-effects, if you run in to issues with this enabled, you are on your own. Must be set to "TRUE" to be enabled | TRUE/unset | Colours @@ -60,6 +65,7 @@ Feed | time_format | Time format to use for post timestamps | DD MMM YYYY HH:mm:ss ZZ | | timezone | IANA time zone to use for post timestamps | GMT (for GMT) or Pacific/Auckland (for other) | | default_amount | Default amount of feed entries to post if the amount specified can not be achieved | 5 is recommended | +| show_feed_title | Show the title of an RSS feed before the output (not yet implemented) | true/false | Twitter