{"id":13658433,"url":"https://github.com/adsr/irslackd","last_synced_at":"2025-04-12T19:44:32.149Z","repository":{"id":42231499,"uuid":"129561758","full_name":"adsr/irslackd","owner":"adsr","description":"self-hosted IRC gateway to Slack","archived":false,"fork":false,"pushed_at":"2025-03-31T23:40:59.000Z","size":545,"stargazers_count":164,"open_issues_count":16,"forks_count":21,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-04T01:01:36.519Z","etag":null,"topics":["hacktoberfest","irc","irc-client","irc-gateway","ircd","slack","slack-gateway"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adsr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-14T23:25:20.000Z","updated_at":"2025-03-31T23:41:02.000Z","dependencies_parsed_at":"2025-02-19T00:11:34.999Z","dependency_job_id":"56d31395-1f4e-418e-a766-79103073e113","html_url":"https://github.com/adsr/irslackd","commit_stats":{"total_commits":221,"total_committers":14,"mean_commits":"15.785714285714286","dds":"0.16742081447963797","last_synced_commit":"2650ea0dc98f790733615768a6a5bc77f72eb9ce"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adsr%2Firslackd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adsr%2Firslackd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adsr%2Firslackd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adsr%2Firslackd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adsr","download_url":"https://codeload.github.com/adsr/irslackd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625479,"owners_count":21135512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","irc","irc-client","irc-gateway","ircd","slack","slack-gateway"],"created_at":"2024-08-02T05:00:59.518Z","updated_at":"2025-04-12T19:44:32.115Z","avatar_url":"https://github.com/adsr.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# irslackd\n\n[Slack ended IRC support][0] on May 15, 2018. So, we built our own Slack-IRC\ngateway.\n\nirslackd is actively developed and used daily on a 1000+ user Slack workspace.\n\n[![Build Status](https://travis-ci.org/adsr/irslackd.svg?branch=master)](https://travis-ci.org/adsr/irslackd)\n\n### Features\n\n* TLS-encrypted IRCd\n* Multiple Slack accounts/workspaces\n* Channels, private channels, DMs, group DMs, threads\n* Receive reactions, message edits, message deletes, attachments\n* Proper en/decoding of @user, #channel, @team tags\n\n### Setup\n\n#### Using docker-compose\n\n1. Clone irslackd and run docker-compose:\n    ```\n    $ git clone https://github.com/adsr/irslackd.git\n    $ docker-compose up\n    ```\n\n    _Recommendation: Watch docker-compose build output for the generated certificate's fingerprint (used later for verification)._\n\n1. Connect your IRC client to irslackd which listens on `127.0.0.1:6697`. See: [Configure your Slack account and IRC client](#configure-your-slack-account-and-irc-client)\n\n#### Manual\n\n1. [Install Node \u003e=8.x][1] and npm. You can check your version of Node by\n   running `node --version`.\n\n2. Clone irslackd:\n    ```\n    $ git clone https://github.com/adsr/irslackd.git\n    $ cd irslackd\n    $ npm install    # Fetch dependencies into local `node_modules/` directory\n    ```\n\n3. Run `./bin/create_tls_key.sh` to create a TLS key and cert. This will put\n   a private key and cert in `~/.irslackd`. Note the fingerprint.\n\n4. Run irslackd:\n    ```\n    $ ./irslackd\n    ```\n\n    By default irslackd listens on `127.0.0.1:6697`. Set the command line\n    options `-p \u003cport\u003e` and/or `-a \u003caddress\u003e` to change the listen address.\n\n### Configure your Slack account and IRC client\n\n1. Follow the link below to obtain an irslackd token for your Slack workspace:\n\n   [![Authorize irslackd](https://platform.slack-edge.com/img/add_to_slack.png)][2]\n   \n   Select the desired workspace in the dropdown in the upper right corner. Click\n   'Authorize', and copy the access token. It will look something like this:\n\n   `xoxp-012345678901-012345678901-012345678901-0123456789abcdef0123456789abcdef`\n\n2. Connect to irslackd via your IRC client, e.g., WeeChat:\n    ```\n    /server add irslackd_workspace localhost/6697\n    /set irc.server.irslackd_workspace.ssl on\n    /set irc.server.irslackd_workspace.ssl_fingerprint fingerprint-from-step-3\n    /set irc.server.irslackd_workspace.password access-token-from-step-5\n    /connect irslackd_workspace\n    ```\n    Check the wiki for more [client configuration notes][5].\n\n3. Repeat steps 1 and 2 for each Slack workspace you'd like to connect to.\n\n4. Enjoy a fresh IRC gateway experience.\n\n### Contribute\n\n* Add more [client configuration notes][5].\n* File bug reports and feature requests via [Github issues][3].\n* Feel free to submit PRs. Make sure to include tests.\n\n### Tests\n\n* To run all tests: `npm test`\n* To run a single test, e.g.: `npm test test_join`\n\n### Related projects\n\n* https://github.com/ltworf/localslackirc (another gateway, Python)\n* https://github.com/insomniacslk/irc-slack (another gateway, Go)\n* https://github.com/wee-slack/wee-slack (a terminal client, WeeChat-based)\n* https://github.com/erroneousboat/slack-term (a terminal client, Go)\n* https://github.com/42wim/matterircd (an IRCd for Mattermost and Slack)\n* https://github.com/dylex/slack-libpurple (Slack plugin for libpurple)\n\n### irslackd Slack workspace\n\n* Feel free to join the [irslackd Slack workspace][4] for testing your\n  irslackd setup.\n\n[0]: https://my.slack.com/account/gateways\n[1]: https://nodejs.org/\n[2]: https://slack.com/oauth/authorize?client_id=2151705565.329118621748\u0026scope=client\n[3]: https://github.com/adsr/irslackd/issues\n[4]: https://join.slack.com/t/irslackd/shared_invite/zt-5s6tvir7-Gp71YBznUVT5_z608xFQRg\n[5]: https://github.com/adsr/irslackd/wiki/IRC-Client-Config\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadsr%2Firslackd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadsr%2Firslackd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadsr%2Firslackd/lists"}