irc-discord-bridgebot

README

irc-discord-bridgebot
=====================
|builds.sr.ht status|

A puppet connection based bidirectional Discord to IRC bridge.

.. |builds.sr.ht status| image:: https://builds.sr.ht/~arsen/irc-discord-bridgebot/commits/master.yml.svg
   :target: https://builds.sr.ht/~arsen/irc-discord-bridgebot/commits/master.yml?

CI
--
Latest :code:`master` build available `here <https://cdn.aarsen.me/builds/irc-discord-bridgebot/master>`_

Unsupported features
--------------------
- Threads

Features in the TODO
--------------------
- Embed rendering
- Markdown rendering
- License notice on Discord
- Strict CSP

Special setup instructions
--------------------------
The program requires :code:`CAP_NET_RAW` and :code:`CAP_NET_BIND_SERVICE` and a full
IPv6 /64 dedicated to it. An additional privsep helper will be provided in the
near future under :code:`privsep/`.

The bridge now serves a HTTP server locally that you should just
reverse proxy via nginx. See the example config.

Environment
-----------
:code:`IDB_CONFIG`
        Path to the config file (defaults to :code:`idb.toml`).

IMPORTANT NOTE
--------------
This has seen light testing, though it should be better than before.
Do report any issues if you decide to deploy.

Contributing and reporting issues
---------------------------------
Reach out to `my mailing list`_, please prefix your subject line with
:code:`irc-discord-bridgebot` or :code:`IDB`, and use
:code:`format.subjectprefix = PATCH irc-discord-bridgebot` for patches.

.. _`my mailing list`: https://lists.sr.ht/~arsen/public-inbox

License
-------
Licensed under the GNU Affero General Public License, version 3. The bot
accepts a :code:`license` private message to get information about the source
code.