mirror of https://github.com/sdr-enthusiasts/docker-planefence.git synced 2025-12-22 11:17:06 +00:00

Files

Dziban303 ca9d9d31bc colors (#243 )

* colors

* handle blank value?

* better documentation

2025-04-30 22:43:48 -04:00

3.4 KiB

Raw Permalink Blame History

Send a message to Discord for each new plane in Planefence

Setting up Discord notifications involves only two simple steps:

Create a Webhook
Configure Planefence

We'll go into the details of each step below.

Send a message to Discord for each new plane in Planefence
Summary of License Terms

Prerequisites

You'll need a Discord server to invite the bot to. Anyone can create their own server for free. Follow these instructions on Discord's support site.

This is part of the [sdr-enthusiasts/docker-planefence] docker container. Nothing in this document will make sense outside the context of this container.

Creating a Webhook URL

If you're sending alerts to a channel that you control you'll need to set up a Webhook URL first. If someone has provided you with a Webhook URL to send alerts to already you can skip to the last step in this section.

In your Discord server right-click the channel you want messages to go to and click "Edit Channel"
In the Integrations page click "Create Webhook"
Config the Name that you'd like messages to appear as and set a profile image then click "Copy Webhook URL"
If you want to post to the #planefence-alert channel on the SDR-Enthusiasts Discord Server (which is where most of us hang out), please join that server and send a DM to @kx1t.

Configure Planefence

In your planefence.config file paste the webhook url into PA_DISCORD_WEBHOOKS to send plane-alert messages and PF_DISCORD_WEBHOOKS to send planefence messages.
If you're posting alerts to a shared channel you can set DISCORD_FEEDER_NAME to something that identifies where the alert came from. If you're near an airport you could use its ICAO identifier.
To get messages from Planefence set PF_DISCORD=ON and to get messages from plane-alert set PA_DISCORD=ON.
To set the highlight color of Plane-Alert messages, set PA_DISCORD_COLOR to a hexadecimal color code with a leading "0x" (0xRRGGBB, so for example 0x00FF00 would be pure green.) The default is 0xf2e718 (a yellow color). You can use this site or this site to pick a color and get its hex code. Note that planes with emergencies, i.e. squawking 7500, 7600, or 7700, will always be highlighted in red (0xff0000) regardless of the color you set, so you shouldn't use red for your normal alerts.

Summary of License Terms

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

3.4 KiB Raw Permalink Blame History