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. |
currency
| name | example | purpose |
|---|---|---|
| auto_convert | False | Whether to convert currencies without an explicit command |
| fiat_provider | ratesapi.io | Which data provider to use (some of which require no API key) |
| fixer_io_key | 0123456789abcdef0123456789abcdef | API key for Fixer.io (widest currency support) |
| fixer_use_ssl | False | Whether to use SSL (HTTPS) for Fixer API (requires paid API access) |
pronouns
| name | example | purpose |
|---|---|---|
| fetch_complete_list | True | Whether to attempt fetching the complete pronoun list from the web backend at startup. |
| link_base_url | https://pronouns.sopel.chat | Base URL for pronoun info links. |
safety
| name | example | purpose |
|---|---|---|
| default_mode | on | Which mode to use in channels without a mode set. |
| known_good | sopel.chat,dftba.net | List of “known good” domains or regexes to consider trusted. This can save VT API calls. |
| vt_api_key | 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef | Optional VirusTotal API key to improve malicious URL detection |
| domain_blocklist_url | https://example.com/bad-hosts.txt | Optional hosts-file formatted domain blocklist to use instead of StevenBlack’s. |
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 |
|---|---|---|
| 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 requests to private and local network IP addresses. |
wikipedia
| name | example | purpose |
|---|---|---|
| default_lang | en | The default language to find articles from (same as Wikipedia language subdomain) |