this repo has no description
dunkirk.sh
1# IRC <> Slack bridge
2
3This is a little bot in active development to bridge slack and irc for Hackclub!
4
5## How do I hack on it?
6
7### Development
8
9This is written in typescript so pretty easy to get started!
10
11```bash
12bun install
13bun dev
14```
15
16### Slack App Setup
17
181. Go to [api.slack.com/apps](https://api.slack.com/apps) and create a new app
192. Choose "From an app manifest"
203. Copy the contents of `slack-manifest.yaml` and paste it
214. Install the app to your workspace
225. Copy the "Bot User OAuth Token" (starts with `xoxb-`) and "Signing Secret"
236. Invite the bot to your desired Slack channel: `/invite @IRC Bridge`
24
25### Environment Setup
26
27Make a `.env` file with the following:
28
29```bash
30# Slack Configuration
31SLACK_BOT_TOKEN=xoxb-your-bot-token-here
32SLACK_SIGNING_SECRET=your-signing-secret-here
33SLACK_CHANNEL=C1234567890 # Optional: for bidirectional bridging
34
35# IRC Configuration
36IRC_NICK=slackbridge
37IRC_CHANNEL=#general
38
39# Admin users (comma-separated Slack user IDs)
40ADMINS=U1234567890
41
42# Server Configuration (optional)
43PORT=3000
44```
45
46See `.env.example` for a template.
47
48### How it works
49
50The bridge connects to `irc.hackclub.com:6667` (no TLS) and forwards messages bidirectionally:
51
52- **IRC → Slack**: Messages from IRC appear in the configured Slack channel
53- **Slack → IRC**: Messages from Slack are sent to the IRC channel (if SLACK_CHANNEL is configured)
54
55The bridge ignores its own messages and bot messages to prevent loops.
56
57If you want to report an issue the main repo is [the tangled repo](https://tangled.org/dunkirk.sh/irc-slack-bridge) and the github is just a mirror.
58
59<p align="center">
60 <img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/master/.github/images/line-break.svg" />
61</p>
62
63<p align="center">
64 © 2025-present <a href="https://github.com/taciturnaxolotl">Kieran Klukas</a>
65</p>
66
67<p align="center">
68 <a href="https://github.com/taciturnaxolotl/irc-slack-bridge/blob/main/LICENSE.md"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8"/></a>
69</p>