Skip to content
A service to open and manage IRC connections for bridges.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
test
tools/ircctl
.gitignore
.travis.yml
LICENSE
README.md
config.yaml
package-lock.json
package.json
screenshot.png
tsconfig.json
tslint.json

README.md

irc-conntrack

Build Status

A service to open and manage IRC connections for other services, written in Typescript.

Matrix Room: #irc-conntrack

The specification lives in this Google doc currently.

A kinda boring screenshot, but the best projects have them

How does it work?

The service is designed to be used with a Matrix appservice, such as matrix-appservice-irc.

A bridge administator would spin up one (or several) instances of this service and configure the configuration file with all the presets needed to connect to an IRC network. Then, they would point the bridge at the service and the bridge would begin to connect all it's users.

Should the bridge crash at some point, the IRC connections remain intact while the bridge restarts and carrys on as normal. If a configuration update is needed on this service, it can be applied without restarting the service.

And of course, you can shard out as many of these as you like to minimize impact of restarting the service.

Great, how do I deploy it and start using it on my bridge.

Alas, this project isn't ready to be deployed yet. There is a lot of work involved in breaking in matrix-appservice-irc to support remote clients, and this service isn't quite ready. However, I hope to have some prototypes to show off soon which will eventually lead into production deployments of this service.

You are invited to join the Matrix room for more up to date news on the happenings of this project.

FAQ

Why not use a well known S2S (Server to Server) protocol, rather than IRC clients?

Using the S2S protocol in a bridge could work in the future, and something this project would be well suited to covering. However, S2S implies a much greater amount of trust in the bridge hoster, their network and the software itself. IRC clients on the other hand can be tightly controlled and hopefully with the right software (this!), indistinguishable.

How to I poke about in the service without using node's inspector?

Glad you asked! There is a bespoke tool called ircctl which allows you to manipulate the service like reloading the config or listing connected clients or even listening in/sending messages over them.

You can’t perform that action at this time.