Setting Up WebSocket Connections for Live Chat

This guide explains how to configure your network so the embedded Kiwi IRC web client can connect to your IRC network. IRC Driven supports two connection modes: gateway mode (default) and direct WebSocket mode.

Prerequisites


  • You must be logged in and have network admin access. See the guide on gaining access if needed.

Where to configure


WebSocket and WebIRC settings are in the Network AdminNetwork Settings (Extended Options) section. From your network page, go to the Admin tab and open the Network Settings / Extended Options form.

Connection modes


Gateway mode (default)

When Use native WebSocket is disabled or the WebSocket URI is blank, the live chat uses IRC Driven's WebIRC gateway. The gateway connects to your IRC server on behalf of web users and forwards connections.

  • WebIRC password — If your network provides a WebIRC password, enter it here. The gateway will send it to your IRC server so web users' hostnames are displayed correctly (instead of the gateway's IP). This improves identification and allows host-based services (cloaks, bans) to work. Contact your IRC server administrator to obtain a WebIRC password if your network supports it.
  • Require SSL — Enable this if your network requires TLS/SSL connections (typically port 6697). The gateway will connect using TLS when this is set.

Most networks use gateway mode with a WebIRC password when available.

Direct WebSocket mode (opt-in)

If your network provides its own WebSocket endpoint for IRC, you can bypass the gateway and connect directly. This is useful when:

  • Your IRC server supports native IRCv3 WebSocket (e.g. Ergo, InspIRCd, UnrealIRCd)
  • Your network runs its own WebIRC WebSocket gateway and you have the public WebSocket URL

To enable direct WebSocket:

  1. Check Use native WebSocket for web chat
  2. Enter the full WebSocket URL in WebSocket URI (e.g. wss://irc.example.com:6697 or wss://gateway.example.com/webirc/ws)

When enabled, the embedded chat connects directly to that URL. The IRC Driven gateway is not used for this network. Ensure the URL is publicly reachable and supports WebSocket connections from browsers.

Summary


Setting Use when
Gateway + WebIRC password Your network gives you a WebIRC password. Web users connect via IRC Driven's gateway; hostnames display correctly.
Gateway (no WebIRC) Default. Works for most networks; web users may show gateway IP as hostname.
Direct WebSocket Your network has IRCv3 WebSocket or its own WebIRC WebSocket endpoint. Bypasses the gateway.

Related


See also Updating a network's settings for the full Network Settings form and other options such as ALIS, /LIST delay, and NickServ.