PHPackages                             jlkaufman/blackhole-bot - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. jlkaufman/blackhole-bot

ActiveLibrary[Utility & Helpers](/categories/utility)

jlkaufman/blackhole-bot
=======================

Blackhole: A Jabber/IRC Gateway Bot

v0.1.0(10y ago)016[4 issues](https://github.com/jlkaufman/blackhole-bot/issues)BSD-3-ClausePHPPHP >=5.6.0

Since Apr 13Pushed 10y ago1 watchersCompare

[ Source](https://github.com/jlkaufman/blackhole-bot)[ Packagist](https://packagist.org/packages/jlkaufman/blackhole-bot)[ RSS](/packages/jlkaufman-blackhole-bot/feed)WikiDiscussions master Synced 4w ago

READMEChangelog (1)Dependencies (7)Versions (2)Used By (0)

Blackhole
=========

[](#blackhole)

This bot will connect to an IRC channel and a Jabber MUC, and relay everything back and forth, serving as a gateway.

Prerequisites
-------------

[](#prerequisites)

It is assumed that you have [composer](http://getcomposer.org) already installed. In order to run this as a service, systemd is required. This was built with Debian 8 in mind. I'm a Debian user, and rarely get onto other distos. If you'd like to further develop the installer, please create a PR and I'll be happy to include it =)

Quick install
-------------

[](#quick-install)

The best way to install this project is with composer. In fact, it's the only supported method. IF you chose to grab the deps and install everything by hand, more power to you. I will not help you with this if you run into problems.

1. Clone this repo
2. run `composer install`
3. run `make`
4. run `sudo make install`
5. edit `/etc/blackhole-bot/blackhole.yml` to suit your needs. It is recommended that you create a user for the bot to run as. You can grab the user's uid with `id -u ` and the gid with `id -g `
6. `service blackhole-bot ` to control the bot after configuration.

Make Targets
------------

[](#make-targets)

1. `make` - Builds the bot
2. `make install` - Installs the bot and installs the systemd service file
3. `make uninstall` - Uninstalls the bot
4. `make clean` - Cleans the working directory

Development
-----------

[](#development)

Development can be done inside the vagrant vm...

1. run `vagrant up`
2. run `vagrant ssh`

For testing purposes you can run the bot with `./bin/bot`. Make sure to copy `config/blackhole.yml.sample` to `config/blackhole.yml` and you're good to go.

- For CLI options, run `./bin/bot -h`

Contributing
------------

[](#contributing)

Anyone is welcome to contribute to the project. Make a fork, make some changes, and create a pull-request to contribute. Please let it be known, I wont accept *any* pull requests with code that doesn't follow [PSR/2](http://www.php-fig.org/psr/psr-2/), or anything that looks to be a mess.

Considerations
--------------

[](#considerations)

This bot is a side project. I will try to maintain it, but I make no promises. If you like it, contribute to it =)

Known issues
------------

[](#known-issues)

- The XMPP library is bullshit. It *desperately* needs a replacement.

###  Health Score

22

—

LowBetter than 21% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3730d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/53496276?v=4)[jlkaufman](/maintainers/jlkaufman)[@jlkaufman](https://github.com/jlkaufman)

---

Tags

botircRelayjabber

### Embed Badge

![Health badge](/badges/jlkaufman-blackhole-bot/health.svg)

```
[![Health](https://phpackages.com/badges/jlkaufman-blackhole-bot/health.svg)](https://phpackages.com/packages/jlkaufman-blackhole-bot)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)