j2i (1.0.1)
Installation
pip install --index-url https://foundry.fsky.io/api/packages/telepath/pypi/simple/ --extra-index-url https://pypi.org/simple j2iAbout this package
Open source bridge software that connects XMPP and IRC channels
j2i
A bridge between XMPP MUCs and IRC channels. Supports both basic plumbing (bot relays messages as text) and puppeteering mode (messages appear from the actual sender's nick).
Features
- Basic plumbing mode - bridge bot relays messages in
<nick> textformat, works with any XMPP and IRC server - Puppeteering - XMPP users appear on IRC with their real nick via RELAYMSG; IRC users appear in XMPP MUCs as puppet JIDs via XEP-0114 component
- Smart replies - XEP-0461 replies from XMPP become
nick:mentions on IRC; IRCv3 reply tags are preserved in the other direction - Message edits - XEP-0308 corrections are relayed to IRC as
* corrected text - Pastebin - messages exceeding a configurable line limit are uploaded to a pastebin and linked instead of flooding
- Typing indicators - XEP-0085 (XMPP) ↔ IRCv3 typing tag
- Anti-ping - zero-width space inserted into relayed nicks to avoid unwanted highlights
- Multiple networks - bridge as many XMPP/IRC connections and channel pairs as you want, each configured independently
Requirements
- Python 3.11+
- slixmpp
Installation
pip/pipx (PyPI)
You can install j2i from PyPI with pip:
pip install j2i
Or with pipx for an isolated environment:
pipx install j2i
pip/pipx (FSKY Foundry)
To download the package from FSKY Foundry instead of PyPI:
pip install j2i --pip-args="--index-url https://foundry.fsky.io/api/packages/telepath/pypi/simple --extra-index-url https://pypi.org/simple"
Or with pipx:
pipx install j2i --pip-args="--index-url https://foundry.fsky.io/api/packages/telepath/pypi/simple --extra-index-url https://pypi.org/simple"
From wheel
Download the wheel from the releases page and install with pip:
pip install j2i-*.whl
Running
Installed package
After installing, simply run:
j2i -c config.toml
Local development
Requires uv:
git clone https://foundry.fsky.io/telepath/j2i.git
cd j2i
cp config.example.toml config.toml
$EDITOR config.toml
uv run j2i -c config.toml
Docker/Podman
The image expects the config file at /config/config.toml.
docker run -v ./config.toml:/config/config.toml foundry.fsky.io/telepath/j2i:latest
Podman quadlet (systemd)
A quadlet unit file is provided in contrib/quadlet/j2i.container. It runs the container as a systemd user service with auto-update enabled and a read-only filesystem.
To install, place the unit file into .config/containers/systemd/ or /etc/containers/systemd/ and run:
systemctl --user daemon-reload
systemctl --user start j2i.service
Configuration
Copy config.example.toml and edit it. The example file has comments explaining every option.
The config has four sections:
[[xmpp]]- one entry per XMPP account or component; setcomponent = truefor XEP-0114 component mode[[irc]]- one entry per IRC network; setrelaymsg = trueto enable RELAYMSG[[bridge]]- one entry per MUC↔channel pair, referencing thenamefields above[settings]- global defaults (anti_ping,max_lines,pastebin, etc.); can be overridden per[[bridge]]
Basic plumbing mode (simple setup)
Set component = false in [[xmpp]] and relaymsg = false in [[irc]]. The bridge connects as a regular XMPP user and IRC bot and relays messages as <nick> text. No special server configuration needed.
Puppeteering mode (full setup)
IRC side: Set relaymsg = true in [[irc]]. The IRC bot must have operator status (+o) in the channel. The bridge detects RELAYMSG support on connect and falls back to basic plumbing mode if unavailable.
XMPP side: Set component = true in [[xmpp]] and configure your XMPP server with a component subdomain. Each IRC user will appear in the MUC as a puppet JID under that domain (e.g. johndoe.libera@irc.example.org). Puppet nicks on IRC get a /xmpp suffix (e.g. alice/xmpp) to distinguish them from real IRC users.
Support chatroom
If you want to ask anything or need assistance with j2i, we have a public chatroom on XMPP and IRC.
- XMPP: j2i@room.telepath.im
- IRC: #j2i on irc.telepath.im
The MUC and channel are bridged together with j2i.
License
This project is released into the public domain under the Unlicense.