sopel.sopel

Deprecated. This role is no longer updated. It's better to use the unofficial official docker image instead.

If someone wants to take over the maintenance, please open an issue and we can discuss it. Most issues are related to continuous integration (CI).

What is ansible-sopel?

It is an Ansible role that sets up the Sopel IRC bot in a virtual environment.

Supported Platforms

Ubuntu 18.04 LTS (Bionic)
Ubuntu 20.04 LTS (Focal)
Debian 9 (Stretch)
Debian 10 (Buster)
CentOS 7
CentOS 8

Dependencies

Python 3
Python venv
Python wheel or build tools

Role Variables

---
# You can change the instance name to run multiple Sopel instances on the same server
# as long as they have different nicknames or connect to different servers.
sopel_instance_name: 'sopel'
sopel_install_dir: '/srv/sopel'
sopel_config_dir: '/etc/sopel'
sopel_log_dir: '/var/log/sopel'
sopel_pid_dir: '/run/sopel'

sopel_install_systemd_service: true
sopel_start_systemd_service: true

# If your system uses a different virtual environment command, you can change this
sopel_venv_cmd: '/usr/bin/python3 -m venv'

# The command prefix used to call the bot.
# Remember to escape special characters as it's read as regex
sopel_command_prefix: '\.'

# The nickname Sopel uses in channels
sopel_nick: 'sopel_irc_bot'
sopel_auth_method: 'sasl'

# The network Sopel should connect to
sopel_irc_host: 'chat.freenode.org'
sopel_irc_port: 6697

# A list of channels for Sopel to join
sopel_channels:
  - '##botspam'

# The administrator of the bot
sopel_bot_owner: ''

# A list of usernames and hostnames for Sopel to ignore, read as regex
sopel_ignored_nicks:
  - ''
sopel_ignored_hosts:
  - ''

# Plugins to enable (all enabled by default)
#sopel_enabled_plugins: []

# Plugins to exclude (none excluded by default)
#sopel_excluded_plugins: []

## Additional Sopel configurations can be added here
#sopel_config_extra: |
#  [currency]
#  auto_convert = true

# Default time zone and format. Visit http://strftime.org/ for format details
sopel_timezone: 'Europe/Copenhagen'
sopel_time_format: '[%Y-%m-%d - %T %Z]'

Example Usage

Here's how to quickly set up two Sopel instances. One will use the default name "sopel", and the other will be called "sopel2". They will also be installed as systemd services with the names: sopel-sopel and sopel-sopel2. Configuration files will be in /etc/sopel/.

---
- name: 'Install Sopel instance 1'
  hosts: vps
  become: true
  tags:
    - sopel

  vars:
    sopel_auth_method: 'nickserv'
    sopel_bot_owner: 'testManDan'
    sopel_nick: Sopel_bot_1
    sopel_auth_user: NICK OWNER HERE
    sopel_auth_pass: NICK PASS HERE

  roles:
   - sopel.sopel

- name: 'Install Sopel instance 2'
  hosts: vps
  become: true
  tags:
    - sopel

  vars:
    sopel_instance_name: 'sopel2'
    sopel_auth_method: 'nickserv'
    sopel_bot_owner: 'testManDan'
    sopel_nick: Sopel_bot_2
    sopel_auth_user: NICK OWNER HERE
    sopel_auth_pass: NICK PASS HERE

  roles:
    - sopel.sopel