Planefence (Dockerized)

Planefence (Dockerized)

Use the Index on the right to learn details, how to install and configure this application, and how to implement a more complex configuration. Your suggestions, bug reports, feature requests, and proposed code changes are always welcome!

• Bug reports and feature requests can be done here
• This repository has 3 branches:
  • Main contains the major releases. The version in this branch is automatically built into a Docker container that is available here: https://hub.docker.com/repository/docker/kx1t/planefence. It can be pulled with docker pull kx1t/planefence
  • Dev is the active development branch. Intermediate code changes are pushed here. Code may be incomplete and probably contains major bugs. This branch is useful if you're helping to develop the next new feature, but it's not production or release ready.
  • Pr contains a release candidate version. If we aren't ready to create a release, this branch may be stale / out of date / non-existent. Contact the author before downloading this.
• If you need further support, please join the #planefence channel at the SDR Enthusiasts Discord Server. If you need immediate help, please add "@ramonk" to your message.

What is it?

This repository contains Planefence, which is an add-on to readsb, dump1090, or dump1090-fa (referred to herein as your Feeder Station.

Planefence will create a log of aircraft heard by your Feeder Station that are within a "fence", that is, less than a certain distance and lower than a certain altitude from your station. This log is displayed on a website and is also made available in daily CSV files. Furthermore, Planefence can send a Tweet for every plane in the fence, and (coming soon!) will be able to collect noise figures to see how loud the aircraft are that fly above your Feeder Station.

The Docker container can be accessed on Dockerhub (kx1t/planefence) and can be pulled directy using this Docker command: docker pull kx1t/planefence.

Who is it for?

In order for you to use it, here are some assumptions or prerequisites:

• You are already familiar the dump1090 family of ADS-B software (for example, readsb, dump1090, or dump1090-fa), how to deploy it, and the hardware needed. Ideally, you have your ADS-B station already up and running.
• You are able to access the software and install additional components.
• You know how to deploy Docker images to your machine. If you don't -- it's actually quite simple and makes installation of new components really easy. I advise you to read Mikenye's excellent Gitbook on the topic, which will show you step by step what to do.
• You use docker-compose. It's not hard to simply do docker run from a script, but this README has been written assuming docker-compose. If you don't have it, feel free to apt-get install it :)
• If you need further support, please join the #planefence channel at the SDR Enthusiasts Discord Server. If you need immediate help, please add "@ramonk" to your message.