The Python IRC Bot

Plugin configuration

This page contains documentation for all plugins within Sopel’s main plugins directory. If you have added plugins without rebuilding the documentation, or are using a secondary plugins directory, those plugins will not be shown here.



name example purpose
hold_ground False Auto-rejoin the channel after being kicked.
auto_accept_invite True Auto-join channels when invited.


name example purpose
domains, A list of Bugzilla issue tracker domains


name example purpose
auto_convert False Whether to convert currencies without an explicit command
fiat_provider Which data provider to use (some of which require no API key)
fixer_io_key 0123456789abcdef0123456789abcdef API key for (widest currency support)
fixer_use_ssl False Whether to use SSL (HTTPS) for Fixer API (requires paid API access)


name example purpose
output clbin The pastebin provider to use for help output
reply_method channel How/where help output should be sent
show_server_host True Whether to show the IRC server’s hostname/IP at the top of command listings


name example purpose
GeoIP_db_path /home/sopel/GeoIP/ Path to the GeoIP database files


name example purpose
meeting_log_path /home/sopel/www/meetings Path to meeting logs storage directory (should be an absolute path, accessible on a webserver)
meeting_log_baseurl Base URL for the meeting logs directory


name example purpose
oblique_instance The Oblique instance to use when evaluating Python expressions (see


name example purpose
enabled_by_default True Enable URL safety in all channels where it isn’t explicitly disabled.
known_good, List of “known good” domains to ignore.
vt_api_key 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef Optional VirusTotal API key to improve malicious URL detection


name example purpose
use_private_reminder false Send reminders as private message
maximum_public 4 Send up to this amount of reminders in public


name example purpose
enable_auto_title yes Enable auto-title.
exclude https?://git\.io/.* A list of regular expressions for URLs for which the title should not be shown.
exclusion_char ! A character (or string) which, when immediately preceding a URL, will stop the URL’s title from being shown.
shorten_url_length 72 If greater than 0, the title fetcher will include a TinyURL version of links longer than this many characters.
enable_private_resolution False Enable URL lookups for RFC1918 addresses.
enable_dns_resolution False Enable DNS resolution for all domains to validate if there are RFC1918 resolutions.


name example purpose
default_lang en The default language to find articles from (same as Wikipedia language subdomain)