Skip to main content

IRC Setup

Overview​

The IRC channel connects Anyy to an IRC network. It supports private messages, channels, lifecycle startup, and live-smoke checks.

IRC is text-only in the current adapter.

Prerequisites​

  • IRC server host.
  • Nickname for Anyy.
  • Optional password.
  • Optional TLS and port settings.
  • Channel list if Anyy should join rooms.

Setup​

Create credentials​

If your IRC network requires NickServ or server password auth, store the password as an Anyy secret.

Configure Anyy​

anyy setup channels irc \
  --set host=irc.example.net \
  --set nick=anyy \
  --write-config

With password:

anyy setup channels irc \
  --set host=irc.example.net \
  --set nick=anyy \
  --secret password='irc-password' \
  --write-config

Setup defaults:

FieldDefault
account_idnetwork
port6667
tlsfalse
channels[]
dm_policyopen
group_policymention
send_chunk_chars400

Edit YAML for list fields:

channels:
  irc:
    tls: true
    port: 6697
    channels:
      - "#anyy"
    mention_aliases:
      - "anyy"

Start Gateway​

anyy gateway start
anyy channels reload

Run doctor checks​

anyy channels doctor irc

Access Policy​

Direct messages​

IRC defaults to dm_policy: open. Use allowlist with nick or account ids when you need tighter access.

Groups​

IRC channels use group_policy: mention by default. Mention the configured nick or alias in channels.

Admins​

IRC access policy admits messages. Command permissions are handled by the shared messaging layer.

Sessions​

Each IRC private message peer or channel maps to an Anyy session.

Media Support​

Inbound media​

IRC does not advertise inbound media support.

Outbound media​

IRC sends text replies only.

Commands​

Use shared messaging commands in private messages or mention Anyy in channels.

Cron Delivery​

anyy cron create \
  --name "IRC reminder" \
  --schedule "30m" \
  --prompt "Send the reminder" \
  --delivery-target current_user_default \
  --delivery-channel irc

Troubleshooting​

  • Cannot connect: check host, port, TLS, and password.
  • Channel messages ignored: mention the nick or configure aliases.
  • Long replies are noisy: lower send_chunk_chars.
  • Nick collision: change nick and restart or reload the channel.