Sopel

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.

Plugins

admin

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

bugzilla

name example purpose
domains bugzilla.redhat.com,bugzilla.mozilla.org A list of Bugzilla issue tracker domains

currency

name example purpose
auto_convert False Whether to convert currencies without an explicit command
fixer_io_key 0123456789abcdef0123456789abcdef Optional API key for Fixer.io (increases currency support)

help

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

ip

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

meetbot

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 http://example.com/~sopel/meetings Base URL for the meeting logs directory

py

name example purpose
oblique_instance https://oblique.sopel.chat/ The Oblique instance to use when evaluating Python expressions (see https://github.com/sopel-irc/oblique)

safety

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

tell

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

url

name example purpose
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.

wikipedia

name example purpose
default_lang en The default language to find articles from (same as Wikipedia language subdomain)
lang_per_channel #YourPants:en,#TusPantalones:es List of #channel:langcode pairs to define Wikipedia language per channel