Project overview

Discord bot currently in use by the FreeBSD Discord server. The objective is to provide a bridge between the different FreeBSD services (Bugzilla, Phabricator, Git, etc) and the Discord platform itself while also introducing preventative measures to combat spam/malicious users.

So far implemented is a handful of commands, event handlers and a webhook that forwards commits of the FreeBSD GitHub repositories to Discord.

Command	Description
!help	Displays available commands
!status	Shows bot status
!role	Allows users the ability to assign themselves roles
!bug	Sends a message embed detailing a problem report from Bugzilla. Additionally, messages matching the FreeBSD Bugzilla URL will trigger this event
!review	Sends a message embed detailing a Differntial revision from Phabricator. Additionally, messages matching the FreeBSD Phabricator URL will trigger this event
!user	Sends a message embed detailing a user

Key events on Discord including message updates, deletions, member removals and bans are logged in a public channel to ensure transparency within our community. Recently, we've seen users attempting to promote malicious advertisements or spam channels. To combat this, we have implemented an "antispam" measure to help identify and reduce these issues as they arise.

While it's not possible to create heuristics that cover every type of behavior, we make a basic attempt to identify the most significant offenders and take appropriate action. In this repository, you will find antispam.rules in the default YAML file that outlines common patterns of spam along with associated timeout values. The goal is to expand this file over time to address more advanced cases effectively.

Building and deployment

Before proceeding to build anything ensure a valid configuration file exists in the root of the project. Example can be found here.

go and bmake must be installed to build the project. Optionally, golangci-lint for linting the code.

Container image (recommended)

Optionally, you can build OCI images and deploy through podman or docker.

# make container

Once successfully built run the images as follows, passing the config.yaml configuration file as a volume mount, replacing $HASH with the according git sha:

# podman run localhost/pulsar-bot:$HASH -v ./config.yaml:/app/config.yaml /app/pulsar-bot
# podman run localhost/pulsar-relay:$HASH -v ./config.yaml:/app/config.yaml /app/pulsar-relay

Container images are automatically published to GitHub on each commit passing the build pipeline. Like above, run the following:

# podman run ghcr.io/lcook/pulsar/bot:$HASH -v ./config.yaml:/app/config.yaml /app/pulsar-bot
# podman run ghcr.io/lcook/pulsar/relay:$HASH -v ./config.yaml:/app/config.yaml /app/pulsar-relay

Manually building

Run:

# make install

This will build and install the Go binaries along with the configuration file. An RC service script is included to allow pulsar to run as a daemon. To enable the service, execute the following command:

# sysrc pulsar_enable=YES
# service pulsar start

If you want to use a custom configuration file that is separate from the global one (located at /usr/local/etc/pulsar), you can do so by using the -c flag followed by the desired absolute path.

Alternatively, specify the configuration that the RC service uses:

# sysrc pulsar_config=/path/to/config.yaml

License

BSD 2-Clause