nephatrine/limnoria-irc repository overview

⁠Limnoria IRC Bot

This is an Alpine-based container running the Limnoria/SupyBot IRC bot.

⁠Supported Tags

• limnoria-irc:latest: Limnoria Bot

⁠Software

• Alpine Linux⁠
• Skarnet S6⁠
• s6-overlay⁠
• Limnoria⁠

⁠Configuration

These are the configuration and data files you will likely need to be aware of and potentially customize.

• /mnt/config/etc/SupyBot.conf
• /mnt/config/etc/supybot/*
• /mnt/config/data/supybot/plugins/*

Modifications to some of these may require a service restart to pull in the changes made.

The Limnoria documentation suggests you should rather change the configuration by interacting with the bot itself using the Config plugin instead.

⁠Container Variables

• TZ: Time Zone (i.e. America/New_York)
• PUID: Mounted File Owner User ID
• PGID: Mounted File Owner Group ID
• LIMNORIA_NETWORK: Initial IRC Network Name
• LIMNORIA_SERVER: Initial IRC Server Name
• LIMNORIA_OWNUSER: Initial Bot Owner Username
• LIMNORIA_OWNPASS: Initial Bot Owner Password

Once you have started up with the above LIMNORIA_* values set, you no longer need to keep those variables - they are only used for initial setup. You can of course also manually create the owner user using the supybot-adduser tool and set up your network and server by editing the SupyBot.conf manually if you prefer.

⁠Testing

⁠docker-compose

services:
  limnoria-irc:
    image: nephatrine/limnoria-irc:latest
    container_name: limnoria-irc
    environment:
      TZ: America/New_York
      PUID: 1000
      PGID: 1000
      LIMNORIA_NETWORK: testnet
      LIMNORIA_SERVER: irc.example.net:6697
      LIMNORIA_OWNUSER: admin
      LIMNORIA_OWNPASS: hunter2
    volumes:
      - /mnt/containers/limnoria-irc:/mnt/config

⁠docker run

docker run --rm -ti code.nephatrine.net/nephnet/limnoria-irc:latest /bin/bash