xBNC Wiki — The Next Generation of IRC Bouncers Wiki v1.0.0

Wiki Using xBNC

Using xBNC

Connecting your IRC client, adding networks, the IRC commands, the web panel, the history and the notifications.

Connecting your IRC client

Any client that lets you set the server, port and server password works. No plugin is needed.

What you wantServer password
A user with a single networkalice:password
Choose the networkalice/example:password
Choose the network and name the devicealice/example@laptop:password
The same login in another orderalice@laptop/example:password
  • Server: your domain or IP (sudo xbncd info shows it).
  • Port: 6697 with SSL from anywhere; 6667 without SSL only from your local network.
  • Password: the same one you use for the panel. You can also put alice/example@laptop in the user field (USER) and the password alone in PASS, or sign in with SASL PLAIN from the client.
  • One connection is one network: for two networks, create two servers in your client (alice/example and alice/other). Clients with soju.im/bouncer-networks (Goguma, gamja, Halloy) see all your networks in a single connection.
  • Device: the @device part is optional but recommended. Each device (@laptop, @phone, @work) gets its own pending history.
  • If you installed by IP, the certificate is self-signed: turn on “accept invalid certificates” in your client.

You do not have to work any of this out: in the panel, Networks → your network → Connect your IRC client shows the real server, port and server password of your account for each network, ready to copy. Write the name of the device and your password there and it builds the complete line (the password is not sent or saved). sudo xbncd info shows the same on the server, with your real users and networks.

From the internet or from your local network

With a domain, the server is not always the same:

Where you areServerPort
Anywhere (the internet)Your domain, for example bnc.example.org6697 with SSL. The router must forward 6697 to the xBNC machine.
At home (the same network as xBNC)The local IP of the xBNC machine, for example 192.168.1.506667 without SSL. 6697 also works, but the domain's certificate is not valid for the IP: turn on “accept invalid certificates”.

From home, the domain only works if your router supports it (it is called NAT loopback or hairpin NAT); many do not, and the connection just fails. That is why the panel has the two options, From the internet and From your local network, with the right data for each.

Network List → Add: "xBNC Example"
Edit → Server: bnc.example.org/6697
Tick "Use SSL for all the servers on this network"
Login method: Server password (/PASS password)
Password: alice/example@hexchat:your-password
With a self-signed certificate: tick "Accept invalid SSL certificates"

If you get the port or SSL wrong

xBNC spots the usual mistakes and tells you in the client itself:

What you see in the clientWhat is happeningWhat to do
Closing link: this port uses SSL/TLS. Enable SSL in your IRC client, or connect to port 6667 without SSL.You connect to 6697 without SSL.Turn on SSL or use 6667 from home.
Closing link: this port only accepts connections from the local network...You use 6667 from outside your network.Use 6697 with SSL.
Certificate error or “invalid certificate”Self-signed certificate (installation by IP).Accept the certificate or move to a domain with Let's Encrypt.
Wrong user or password (user "alice")…Wrong user or password.Use the same user and password as in the panel: alice/example@device:password.
"YOUR_PASSWORD" is the example…The example was copied without writing the password.Write your password after the colon. This does not count as a failed attempt.
There is no network called "…" in your account. Your networks: …The network in the server password does not exist (it is the short name of the network in the panel).Use one of the names listed.
Say which network to use in the server password…You have several networks and did not say which.Add /network to the user.
Too many failed logins from your address (…): it is blocked for N more minutesYour IP is blocked after failed attempts, on IRC and in the panel. A client that keeps reconnecting with a wrong password also counts.Correct the password in the client (or close it) and wait, or ask an administrator to unblock it in Security → Blocked IPs.

When the client connects with SSL to a port without SSL it cannot show any message: the service log says so (client sent TLS to a plain-text port).

Networks without SASL (Undernet, QuakeNet)

Some networks do not use SASL: you log in with a services bot, X on Undernet or Q on QuakeNet. xBNC does it for you every time it connects. Turn on the Services login module (in the wizard, the Account step) with your account and password. If you prefer to do it by hand, write the commands in Settings → Commands on connect, one per line, as in your client:

/mode $nick +x
/msg x@channels.undernet.org login YOUR_ACCOUNT YOUR_PASSWORD

They are sent before joining channels, and they are stored encrypted. When the commands (or the module, with “Hide my IP”) ask for +x, xBNC does not join any channel, and holds the JOINs of your client too, until the network confirms the hidden host (numeric 396). Your real address is never shown in a channel. If the host is not hidden after the wait (for example, because the X login failed), the channels stay waiting and *status tells you why; they are joined as soon as the host is hidden, or right away with /msg *status joinnow.

Client compatibility

The automatic tests use a standard IRC client, a client with every IRCv3 capability and a classic client without any. HexChat, mIRC, WeeChat and irssi have been used by hand with xBNC; the other clients in the list follow the same standards but have not been checked one by one. If something does not work with a particular client, report it with the client's name and version (see Testing the beta).

Networks

Settings of a network

In the panel, Networks → (your network) → Configuration. Also with the API (PATCH /networks/{id}) or the command line.

SettingWhat it is
Short nameThe one you use to log in (alice/example). Changing it does not cut the connection.
Server and portAddress of the network. Port 6697 with TLS by default.
TLSEncrypted connection to the network. The server's certificate is always verified.
NickYour nick on the network. If it is taken when connecting, xBNC adds “_” and, with Keep nick, goes back to it as soon as it is free.
User (ident) and real nameThe USER fields. By default, the nick.
Server passwordSent with PASS when connecting. Stored encrypted and never shown again.
SASL account and passwordSASL PLAIN identification. For SASL EXTERNAL, use a client certificate.
EnabledWhen off, xBNC does not connect to that network.
Commands on connectLines sent after connecting and before joining the channels (see below).
ChannelsSaved channels, with their key (encrypted). A /join or /part from the client is saved on its own.
Retention per channelHow long a channel's history is kept: the server setting, nothing, forever or N days.
Backup serversOther servers of the same network that xBNC tries if the current one fails. With /msg *status addserver (see IRC commands).
Trusted certificatesSHA-256 fingerprints of server certificates accepted even if they do not validate (self-signed or expired). With /msg *status addfingerprint.
Local address (vhost)The IP of this server used to connect to the network. With /msg *status setbindhost (administrators only).
Disabled channels and orderA disabled channel stays saved but is not joined; the order is the joining order when connecting. With /msg *status disablechan and movechan.

Commands on connect

They are written as in your client, one per line (up to 20, of 510 characters each), and stored encrypted because they often contain passwords. $nick is replaced by your current nick. Allowed: /msg (or /privmsg, /query), /notice, /quote (or /raw) and any IRC command with a slash (/mode, /away…). A line without a slash is sent as it is.

/mode $nick +x
/msg x@channels.undernet.org login YOUR_USER YOUR_PASSWORD
AWAY :Connected from xBNC

To identify with X, NickServ, Q or AuthServ the Services login module is better: it waits for the network to confirm the login before joining the channels, and on Undernet it uses Login on Connect.

Undernet

Undernet uses the X service and has neither SASL nor TLS. Turn on Services login with your X account: with Login on Connect the account travels in the server password (+x! account password), so your real IP is never seen and you join the channels already as account.users.undernet.org.

*** Your host is now y2k.users.undernet.org
* y2k has joined #xbnc
*statusxBNC v1.0.0 - https://xbnc.org
  • With Invite and unban, if you cannot join one of your channels, xBNC asks X for INVITE or UNBAN.
  • Ignore uses SILENCE: messages from the people you ignore do not even reach xBNC.
  • Nicks have at most 12 characters; the away nick is shortened automatically.
  • Many Spanish-speaking channels use Latin-1: xBNC always understands it, and with Character encoding you can write to them in Latin-1.
  • The connection to Undernet is unencrypted because the network offers no TLS; the X password travels in clear text to the server, as with any client.

Libera.Chat and freenode

Identification by SASL: put your account and password in the network configuration. On Libera you can also use a certificate (Client certificate) with SASL EXTERNAL: generate the certificate in the panel, connect identified, type /msg NickServ CERT ADD and reconnect. If your nick is taken when connecting, Services login with “Recover my nick” sends REGAIN (Libera) or GHOST (freenode).

Rizon

NickServ (Anope), by SASL or with Services login. ChanServ handles invitations and unbans.

EvilNet

You identify with NickServ (IDENTIFY account password). Choose NickServ in Services login, or “Automatic”, which uses NickServ on EvilNet.

QuakeNet

The Q service (AUTH to Q@CServe.quakenet.org) and +x. Services login does it for you; invite and unban use INVITE and UNBANME.

IRCnet and EFnet

They have no NickServ: anyone could take that nick. That is why, in “Automatic”, xBNC never sends your services password on these networks and says so in *status and in the log. IRCnet offers optional SASL with accounts from sasl.ircnet.com. To keep op without services, use Get op back when left alone.

OFTC and other networks with NickServ

Services login with NickServ, or commands on connect. For the client certificate, OFTC uses the SHA-1 fingerprint and Libera the SHA-512 one: the panel shows all three fingerprints (SHA-1, SHA-256 and SHA-512).

IRC commands

You type them in your client as /msg *service command. The answers come in your language.

*status

It is the main service: everything you can do with a network in the panel can also be done here. /msg *status help lists the commands grouped and with their names in bold, only those your account may use; /msg *status help <command> explains one with an example, and /msg *status help <word> searches (for example help channel). Names are not case-sensitive, and the names used by other bouncers are accepted too (ListChans, ListMods, AddTrustedServerFingerprint…), listed under each command as “Also accepted”.

*statusxBNC *status commands
*statusWrite them as /msg *status <command>. Details and an example: help <command>.
*statusChannels
*status channels Your channels: users, modes and state
*status nicks <#channel> Everyone in a channel, with their rank
*status topics The topic of every channel

Unless stated otherwise, any account may use a command. The others say who may: accounts allowed to make changes (every role except “limited”), administrators (administrator and superadministrator) or superadministrators. Administrative actions are recorded in the audit log.

General

CommandWhat it does
help [command]This list, or the details of one command. Without a command, lists every command you can use. With one, shows how it works and an example. You can also search: help chan.
Example: /msg *status help addserver
versionxBNC version.
Example: /msg *status version
uptimeHow long xBNC and this network have been running.
Example: /msg *status uptime
language <code>Your language, also for the web panel. Changes the language of xBNC's messages, the plugins and the web panel at once. Without a code it lists the installed languages.
Example: /msg *status language en
seenWhen you were last connected.
Example: /msg *status seen
showmotdThis server's message of the day.
Example: /msg *status showmotd
clients [user]Devices connected to this network. Administrators can name a user to see all of theirs.
Example: /msg *status clients
Also accepted: listclients

Networks and connection

CommandWhat it does
statusState of this network: server, TLS, nick, capabilities.
Example: /msg *status status
networksYour networks and their state.
Example: /msg *status networks
Also accepted: listnetworks
addnetwork <name> <server> [[+]port]Add a network to your account. A + before the port means TLS. Without a port: 6697 with TLS. Your nick is the one of this network. Then connect with user/name.
Example: /msg *status addnetwork libera irc.libera.chat +6697
delnetwork <name> confirmDelete one of your networks and its history. Asks for confirmation: repeat the command adding "confirm". It cannot be undone.
Example: /msg *status delnetwork test confirm
setnick <nick>Change the nick saved for this network.
Example: /msg *status setnick y2k
Only accounts allowed to make changes (not the limited role).
connectConnect to the network again.
Example: /msg *status connect
Only accounts allowed to make changes (not the limited role).
disconnectDisconnect and stay disconnected. xBNC stays disconnected from this network until you use connect.
Example: /msg *status disconnect
Only accounts allowed to make changes (not the limited role).
jump [server]Reconnect, to the next server or to the one you name. Without a server, goes to the next one of the list (servers). With one, connects to it.
Example: /msg *status jump irc2.example.org
Only accounts allowed to make changes (not the limited role).

Servers, certificates and addresses

CommandWhat it does
serversServers of this network (main and backups). If a server fails, xBNC tries the next one in turn.
Example: /msg *status servers
Also accepted: listservers
addserver <server> [[+]port] [password]Add a backup server. A + before the port means TLS. Without a port: the same as the main server. Up to 20.
Example: /msg *status addserver irc2.example.org 6667
Only accounts allowed to make changes (not the limited role).
delserver <server> [port]Remove a server. If you remove the main server, the first backup becomes the main one.
Example: /msg *status delserver irc2.example.org
Only accounts allowed to make changes (not the limited role).
addfingerprint <SHA-256>Trust a server certificate by its fingerprint. For servers with a self-signed or expired certificate. 64 hex digits, with or without colons. Applies on the next connection.
Example: /msg *status addfingerprint 3F:9A:...:C2:1E
Also accepted: addtrustedserverfingerprint
Only accounts allowed to make changes (not the limited role).
delfingerprint <SHA-256>Stop trusting a certificate.
Example: /msg *status delfingerprint 3F:9A:...:C2:1E
Also accepted: deltrustedserverfingerprint
Only accounts allowed to make changes (not the limited role).
fingerprintsTrusted certificates of this network.
Example: /msg *status fingerprints
Also accepted: listtrustedserverfingerprints
showbindhostLocal address used to connect.
Example: /msg *status showbindhost
setbindhost <IP>Local address for this network (vhost). One of this server's IP addresses. Applies on the next connection (jump).
Example: /msg *status setbindhost 203.0.113.25
Administrators only.
clearbindhostUse the automatic address for this network.
Example: /msg *status clearbindhost
Administrators only.
setuserbindhost <IP>Default local address for all your networks. A network's own address (setbindhost) takes priority.
Example: /msg *status setuserbindhost 2001:db8::25
Administrators only.
clearuserbindhostRemove your default local address.
Example: /msg *status clearuserbindhost
Administrators only.

Channels

CommandWhat it does
channelsYour channels: users, modes and state.
Example: /msg *status channels
Also accepted: listchans
nicks <#channel>Everyone in a channel, with their rank.
Example: /msg *status nicks #xbnc
Also accepted: listnicks
topicsThe topic of every channel.
Example: /msg *status topics
enablechan <#channels>Join saved channels that were disabled. Accepts several channels and the wildcards * and ?.
Example: /msg *status enablechan #xbnc #xbnc-dev
Only accounts allowed to make changes (not the limited role).
joinnowJoin your channels now, without waiting for the hidden host. When you ask for a hidden host (/mode $nick +x in the commands on connect, or the Services login module), xBNC does not join any channel until the server hides your host, so your real address is never shown. This command joins them right away anyway.
Example: /msg *status joinnow
disablechan <#channels>Leave channels but keep them saved. They are not joined again until enablechan. Accepts * and ?.
Example: /msg *status disablechan #xbnc*
Only accounts allowed to make changes (not the limited role).
attach <#channels>Show detached channels again.
Example: /msg *status attach #xbnc
detach <#channels>Hide channels from your client (they keep recording). A mention brings the channel back. Accepts * and ?.
Example: /msg *status detach #xbnc
Only accounts allowed to make changes (not the limited role).
movechan <#channel> <position>Change a channel's place in the order. The order is the one in which xBNC joins and lists your channels.
Example: /msg *status movechan #xbnc 1
Only accounts allowed to make changes (not the limited role).
swapchans <#channel1> <#channel2>Swap the places of two channels.
Example: /msg *status swapchans #xbnc #xbnc-dev
Only accounts allowed to make changes (not the limited role).

History (buffers)

CommandWhat it does
playbuffer <#channel|nick> [lines]Play back the history of a conversation. Sends you the last lines (50 by default, up to 1000).
Example: /msg *status playbuffer #xbnc 100
clearbuffer <#channel|nick>Delete the history of a conversation. Accepts * and ?.
Example: /msg *status clearbuffer bob
Also accepted: clearhistory
clearallbuffersDelete all the history of this network.
Example: /msg *status clearallbuffers
clearallchannelbuffersDelete the history of every channel.
Example: /msg *status clearallchannelbuffers
clearallquerybuffersDelete the history of every private conversation.
Example: /msg *status clearallquerybuffers
setbuffer <#channel> <days|forever|none|default>How long a channel's history is kept. forever: never deleted; none: not stored; default: the server setting; or a number of days.
Example: /msg *status setbuffer #xbnc 90
Only accounts allowed to make changes (not the limited role).

Modules and plugins

CommandWhat it does
modulesModules and plugins of this network and their state.
Example: /msg *status modules
Also accepted: listmods
availmodsEvery module and plugin, with what it does.
Example: /msg *status availmods
Also accepted: listavailmods
enable <module|plugin>Turn on a module or plugin on this network.
Example: /msg *status enable away
Also accepted: loadmod
Only accounts allowed to make changes (not the limited role).
disable <module|plugin>Turn it off.
Example: /msg *status disable away
Also accepted: unloadmod
Only accounts allowed to make changes (not the limited role).
reloadmod <module|plugin>Restart a module or plugin on this network.
Example: /msg *status reloadmod trivia
Also accepted: updatemod
Only accounts allowed to make changes (not the limited role).
get <module|plugin>Show its settings.
Example: /msg *status get away
set <module> <setting> <value>Change a setting. For yes/no settings: on/off. See the names with get.
Example: /msg *status set away delay 60
Only accounts allowed to make changes (not the limited role).
addline <module> <setting> <text>Add a line to a list setting.
Example: /msg *status addline watch patterns *xbnc*
Only accounts allowed to make changes (not the limited role).
dellines <module> <setting>Empty a list setting.
Example: /msg *status dellines watch patterns
Only accounts allowed to make changes (not the limited role).

Administration

CommandWhat it does
usersEvery account and whether it is connected.
Example: /msg *status users
Also accepted: listusers
Administrators only.
allnetworksEvery network of every user, with its state.
Example: /msg *status allnetworks
Also accepted: listallusernetworks
Administrators only.
trafficTraffic and messages since xBNC started.
Example: /msg *status traffic
Administrators only.
broadcast <message>Send a notice to every connected user.
Example: /msg *status broadcast Restart at 23:00
Administrators only.
movenetwork <user> <network> <new user> [new name]Move a network to another user. The network reconnects as the new user, with its history.
Example: /msg *status movenetwork ana libera bob
Administrators only.
rehashRe-read users, networks, channels and languages. For changes made with the xbncd command line. Changes in xbnc.toml need a restart.
Example: /msg *status rehash
Also accepted: reload
Administrators only.
listportsPorts xBNC listens on. Ports are set in xbnc.toml (or with the installer) and need a restart.
Example: /msg *status listports
Administrators only.
saveconfigSave the settings. Not needed: xBNC saves every change at once.
Example: /msg *status saveconfig
Administrators only.
setmotd <text>Set this server's message of the day. Users receive it from *status when they connect. Up to 20 lines.
Example: /msg *status setmotd Welcome to xBNC
Superadministrators only.
addmotd <text>Add a line to the message of the day.
Example: /msg *status addmotd Rules: /msg *status help
Superadministrators only.
clearmotdRemove the message of the day.
Example: /msg *status clearmotd
Superadministrators only.
restart [message]Restart xBNC. Every network reconnects. The message, if any, is sent to everyone first.
Example: /msg *status restart Updating
Superadministrators only.
shutdown [message]Stop xBNC completely. It stays stopped until it is started again on the server (systemctl start xbnc).
Example: /msg *status shutdown Maintenance
Superadministrators only.

Notes on these commands

  • Backup servers. If connecting to a server fails, xBNC tries the next one on the list a second later, and after going through the whole list it waits as usual again (5 s, 10 s, 20 s… up to 5 min). If a server that was connected drops the connection, xBNC first goes back to that same server. Passwords of backup servers are stored encrypted. jump alone moves to the next one; jump server or jump server:port, to a particular one.
  • Trusted certificates. For networks with a self-signed or expired certificate, or one with another name. xBNC still checks everything else about TLS and accepts only that particular certificate (its SHA-256 fingerprint). To see a server's fingerprint: openssl s_client -connect irc.example.org:6697 </dev/null 2>/dev/null | openssl x509 -noout -fingerprint -sha256
  • Local address (vhost). Administrators only, because it uses the server's IP addresses. xBNC checks that the address belongs to the machine before saving it. The network's address takes priority over the user's. It applies on the next connection.
  • Disabled channels. They stay saved with their key and settings, but xBNC does not join them when connecting. The panel marks them as “Disabled”. enablechan joins them straight away.
  • Channel order. It is the order in which xBNC joins when connecting and in which channels and the panel list them. New channels go at the end.
  • Wildcards. enablechan, disablechan, attach, detach and clearbuffer accept several names separated by spaces or commas, and the wildcards * and ?: disablechan #xbnc* #xbnc-dev.
  • Message of the day. A superadministrator sets it and every user receives it, as a notice from *status, each time a client connects. Up to 20 lines of 400 characters. Shown with showmotd.
  • Notices to everyone. broadcast sends “[Administrator notice] text” to every running network; every connected client receives it. restart and shutdown with a message send it first.
  • Restarting and stopping. restart restarts xBNC inside the same process (the networks reconnect). shutdown stops it completely and systemd does not start it again: it has to be started with sudo systemctl start xbnc.
  • Ports and xbnc.toml. Ports and the rest of xbnc.toml are not changed from IRC: listports shows them and rehash re-reads users, networks, channels and languages (the same as sudo systemctl reload xbnc). saveconfig exists out of habit: xBNC saves every change at once.

*notes

CommandWhat it does
listYour notes.
get <key>Show a note.
add <key> <text>Save a note (up to 400 characters).
del <key>Delete a note.

They are the same notes as in Your account → Notes.

*watch

Matches of the Watch words module arrive here. /msg *watch help reminds you how to configure it.

*crypt

CommandWhat it does
setkey <#channel|nick> [cbc:]<key>Save the FiSH key of a channel or private conversation (cbc: for CBC mode). Stored encrypted.
delkey <#channel|nick>Delete a key.
keyx <nick>Agree on a key in private with DH1080 (the other person needs FiSH).
listConversations with a key.

Type +p before a message to send it unencrypted. See Message encryption.

*ignore

CommandWhat it does
add <nick or mask>Ignore someone (a nick, or nick!user@host with *).
del <nick or mask>Stop ignoring.
listList of ignored people.

One service per plugin

Each active plugin answers on *id (*trivia, *remind, *poll…). With help or any text it does not understand, it explains how it is used. If a plugin has nothing to say, xBNC answers with its name, version, description and usage.

Client commands

CommandWhat it does
/quote DETACH #channelDetaches a channel: it keeps recording, but does not appear in your client.
/quote ATTACH #channel or /join #channelShows a detached channel again, with the latest messages.
/quote <alias> [arguments]Runs an alias if your client does not send commands it does not know.

Web panel

PageWhat it is for
HomeLive state of your networks (updated every 2 seconds) and, for administrators, memory, CPU, traffic, connections, blocked IPs, active alerts and new version notices.
ChatWeb IRC client: channels and private conversations of all your networks, with history. The panel counts as one of your devices.
MentionsEverything said to you in private or where your nick was written, newest first.
NetworksAdd (four-step wizard) and edit networks; control (connect, disconnect, reconnect); channels; connected devices (with a button to disconnect one); history with search and export; commands on connect; client certificate; the card “Connect your IRC client”.
ModulesModules and plugins of each network. A network selector that works with any number of networks, and “Copy to other networks” (modules and plugins, except the certificate).
PluginsOfficial and remote catalogue, one-click installation or uploading a .wasm, permissions and approved sites, turning them on or off on the server, uninstalling, live log and development mode (superadministrators).
UsersNew accounts, roles, quotas of networks, devices and history, suspension, password reset, usage of each account and import from another bouncer.
SecuritySign-in attempts (IRC, panel and tokens), blocked IPs with a button to unblock them, open sessions and an audit log of every action.
SettingsHistory, limits, access protection, default language, alerts, backups, updates and restarting the service.
Your accountProfile photo (cropped to 256×256 in the browser; PNG, JPEG or WebP up to 256 KB; seen by you and the administrators), language, time zone, notifications, password, two-step verification, passkeys, linked external accounts, notes, API tokens, test report and open sessions.

Live settings

What you change in Settings is stored in the database, applies without restarting and takes priority over xbnc.toml. The ↺ icon next to a field goes back to the value of xbnc.toml.

GroupSettingsDefault
HistoryDays of retention (0: forever); messages played back on reconnection; messages for a new device; CHATHISTORY limit.30 days; 1000; 100; 500
LimitsTotal connections; devices per user; networks per user; queue per client (lines before a slow client is disconnected). Each user can have exceptions in Users.1000; 10; 10; 4096
Access protectionFailed attempts before blocking; window; length of the block; time to complete the login.5; 600 s; 900 s; 30 s
GeneralDefault language for people who have not chosen one in Your account. It is saved and applied when clicked, also to whoever changes it.the one in xbnc.toml
AlertsSee Monitoring.
BackupsAutomatic yes/no, every how many hours (1–720) and how many to keep (1–365).no; 24 h; 7

What is read at start (ports, certificates, database, secret key, the panel itself and the log level) is changed in xbnc.toml and needs sudo systemctl restart xbnc. The page says so. Superadministrators also have a button to restart the service.

Accessibility and use on the phone

  • Keyboard navigation with visible focus; dialogs close with Escape.
  • Respects the system's “reduce motion”.
  • On narrow screens the side bar opens with the menu button.
  • The theme (light, or dark in black, yellow and grey) follows the system the first time; the moon or sun button changes it and remembers it in that browser.
  • It can be installed as an app (PWA) to get push notifications.
  • In English and Spanish, and in any language installed as a translation file (see Translating xBNC). The language is changed on the sign-in page, in Your account or (the server default) in Settings, and applies at once to the panel and to xBNC's messages on IRC, also with the client connected. From IRC it is changed with /msg *status language en.

History and search

xBNC stores the messages of channels and private conversations (and, with the Events module, joins, parts, kicks, nick changes, topics and modes). Each message carries the server's time if the network sends it.

Searching

In Networks → (network) → History, or with the API. The search uses a full-text index:

  • It finds whole words and word beginnings: deplo finds “deployment”.
  • It ignores case and accents: cafe finds “Café”.
  • Several words must all appear, in any order. In quotes, the exact phrase is searched: "out of service".
  • If nothing matches by word, it also looks for pieces in the middle of a word: ployment finds “deployment”.
  • It combines with the conversation, sender and date filters.

Export and delete

It exports to TXT or JSON (everything, or one conversation). A conversation or the whole history of the network is deleted from the panel, with /msg *status clearbuffer (or clearallbuffers, clearallchannelbuffers, clearallquerybuffers) or with the API.

Retention and quotas

  • General: Settings → History, days of retention (30 by default; 0, forever).
  • Per channel: in the channels of each network, or with /msg *status setbuffer: the server setting, store nothing, forever or N days.
  • Per user: an administrator can set a history space quota (max_history_mb) in Users; usage shows on each user's page.
  • Space: about 150 bytes per stored message, including the search index.

Log files

Besides the history, the Log files module writes daily text files in the classic IRC format to /var/lib/xbnc/logs/user/network/#channel/YYYY-MM-DD.log, with times in your time zone.

Notifications

In Your account → Notifications, xBNC tells you about mentions and private messages.

OptionWhat it doesDefault
Turn on notificationsMain switch.no
Only when I have no client connectedNo notice if you have an IRC client or the panel chat open.yes
When someone writes my nick in a channelMentions.yes
When I get a private messagePrivate messages.yes
ChannelWhat you need
Browser and phone (push)Click “Turn on in this device” from the panel open on that device. On the phone, install the panel as an app first. It can be turned on on several devices.
TelegramCreate a bot with @BotFather, write to it once and enter its token and your chat id (@userinfobot tells you). The panel never shows the full token again.
DiscordA channel webhook: Channel settings → Integrations → Webhooks. Notifications mention nobody.
E-mailYour address. The administrator has to configure the [smtp] section of xbnc.toml.
Your own web addressAn https URL that receives a POST with the notification in JSON.

“Send a test notification” sends one to every configured channel. So as not to flood you, xBNC groups notifications: if many arrive in a row, those not sent are counted and the next notification says how many were skipped.

Format of the notification at your own web address

{
  "network": "example",
  "network_id": 1,
  "conversation": "#xbnc",
  "from": "bob",
  "text": "y2k, what time is the meeting tomorrow?",
  "private": false,
  "ts": 1762851240000,
  "skipped": 0
}

With push, tapping the notification opens the panel chat in that conversation.