Skip to content

Setting up KiwiBNC

Jump to bottom
Daniel Oaks edited this page Jun 24, 2019 · 1 revision

We're currently working on this bouncer, as well as writing some close integrations for it with KiwiIRC. While there's still a lot to do to get both projects working better together and more consistently, you can try it out today and give us feedback if you don't mind the possibility of some broken software :)

First off, setting up KiwiBNC:

  1. Install RabbitMQ using the instructions in the sidebar of the download page.
  2. Start RabbitMQ using something like rabbitmq-server
  3. Clone or get KiwiBNC in its own folder.
  4. Install the dependencies with npm install
  5. Modify the bnc's config.ini, specifically the listener, e.g. 127.0.0.1:3001
  6. Run node src/server.js adduser to add your username to the bouncer.
  7. Run node src/server.js to start and run the bouncer – you should see it start the sockets and the worker components.

You should now be able to connect any client to the listener address you've configured, but KiwiIRC does have a specific bouncer mode which we'll go through configuring.

To setup KiwiIRC locally, follow the general setup guide over here. These specific config changes are ones that should setup bouncer mode nicely for a local install:

  1. Make startupOptions.server and .port point towards your bouncer details, e.g. "server": "localhost", "port": 3001, (configuring upstream connections is done by just adding servers like normal while using KiwiIRC).
  2. Set startupOptions.nick and .password to your bouncer username and password, e.g. "nick": "dan", "password": "password",
  3. Set startupOptions.allowNoChannel to true and startupOptions.remember_buffers to false, e.g. "allowNoChannel": true, "remember_buffers": false,
  4. Set startupOptions.bouncer to true, e.g. "bouncer": true,
  5. Run KiwiIRC, visit the page and then click Start!
  6. You should now be using the bouncer!

Hopefully this should get you running! Keep in mind that right now there are bugs, there are things we haven't polished, and KiwiBNC is currently being developed, so your mileage may vary in terms of stability and such ;)

I've got my config setup here, which should give more context to the config changes listed above: https://gist.github.com/DanielOaks/7787712f68f9bfe60f633ac50f6c4033

Clone this wiki locally