FlightAware's PiAware docker container including support for RTL-SDR, bladeRF and others. Includes dump1090 and dump978.
Builds and runs on linux/amd64, linux/386, linux/arm/v7 and linux/arm64.
For more information on what PiAware is, see here: FlightAware - PiAware.
This container can operate in "net only" mode and pull ADS-B Mode-S & UAT data from another host/container. This is the recommended way of deploying the container, and I'd humbly suggest sdr-enthusiasts/docker-readsb-protobuf and sdr-enthusiasts/docker-dump978 (if you live in an area that uses UAT).
Note: bladerf/hackrf/limesdr/radarcape - Support for these is compiled in, but I need to complete the wrapper/helper scripts. I don't have access to these devices. If you do, and would be willing to test, please get in touch with me!
Please see: Buster-Docker-Fixes!
- sdr-enthusiasts/docker-piaware
- Note for Users running 32-bit Debian Buster-based OSes on ARM
- Table of Contents
- Supported tags and respective Dockerfiles
- Multi Architecture Support
- Prerequisites
- Determining your Feeder ID
- Deployment Examples
- Example
docker runcommand with RTL-SDR USB for reception of 1090MHz - Example
docker-compose.ymlwith RTL-SDR USB for reception of 1090MHz - Example
docker runcommand with 2x RTL-SDR USB for reception of 1090MHz and 978MHz - Example
docker-compose.ymlwith 2x RTL-SDR USB for reception of 1090MHz and 978MHz - Example
docker runwith external Mode-S/BEAST provider - Example
docker-compose.ymlwith external Mode-S/BEAST provider - Example
docker runwith external Mode-S/BEAST provider and external UAT provider - Example
docker-compose.ymlwith external Mode-S/BEAST provider and external UAT provider
- Example
- Environment Variables
- Ports
- Claiming Your Receiver
- Logging
- Other services to feed
- Getting help
latestshould always contain the latest released version of piaware and support tools, for all supported architectures.- Specific version and architecture tags are available if required, however these are not regularly updated. It is generally recommended to run
latest. - There are also
latestand version-specific tags appended with_nohealthcheckwhere the container healthchecks have been excluded from the image build. See issue #43.
Currently, this image should pull and run on the following architectures:
linux/i386linux/amd64linux/arm/v7linux/arm64
In order to ensure dump1090 is optimised for the hardware running it, the dump1090 binary is built on first-run of the container.
If using an RTL-SDR, before this container will work properly, you must blacklist the kernel modules for the RTL-SDR USB device from the host's kernel.
To do this, create a file /etc/modprobe.d/blacklist-rtl2832.conf containing the following:
# Blacklist RTL2832 so docker container piaware can use the device
blacklist rtl2832
blacklist dvb_usb_rtl28xxu
blacklist rtl2832_sdrOnce this is done, you can plug in your RTL-SDR USB device and start the container.
Failure to do this will result in the error below being spammed to the container log.
2019-04-29 21:14:31.642500500 [dump1090-fa] Kernel driver is active, or device is claimed by second instance of librtlsdr.
2019-04-29 21:14:31.642635500 [dump1090-fa] In the first case, please either detach or blacklist the kernel module
2019-04-29 21:14:31.642663500 [dump1090-fa] (dvb_usb_rtl28xxu), or enable automatic detaching at compile time.
2019-04-29 21:14:31.642677500 [dump1090-fa]
2019-04-29 21:14:31.642690500 [dump1090-fa] usb_claim_interface error -6
If you get the error above even after blacklisting the kernel modules as outlined above, the modules may still be loaded. You can unload them by running the following commands:
sudo rmmod rtl2832_sdr
sudo rmmod dvb_usb_rtl28xxu
sudo rmmod rtl2832You need to specify a feeder-id for the container, as this is used by FlightAware to track your PiAware instance.
Make sure you set your feeder ID via the FEEDER_ID environment variable. Failure to do this will cause a new FlightAware site ID to be generated every time you launch the container.
You'll need your feeder-id from your existing feeder.
To get your feeder-id, log onto your feeder and issue the command:
piaware-config -show feeder-idYou'll need a feeder-id. To get one, you can temporarily run the container, to allow it to communicate with the FlightAware servers and get a new feeder ID.
Run the commands:
docker pull ghcr.io/sdr-enthusiasts/docker-piaware:latest
timeout 30 docker run --rm ghcr.io/sdr-enthusiasts/docker-piaware:latest | grep "my feeder ID"The command will run the container for 30 seconds, which should be ample time for the container to receive a feeder-id.
For example:
timeout 30 docker run --rm ghcr.io/sdr-enthusiasts/docker-piaware:latest | grep "my feeder ID"Will output:
Set allow-mlat to yes in /etc/piaware.conf:1
Set allow-modeac to yes in /etc/piaware.conf:2
Set allow-auto-updates to no in /etc/piaware.conf:3
Set allow-manual-updates to no in /etc/piaware.conf:4
2020-03-06 06:16:11.860212500 [piaware] my feeder ID is acbf1f88-09a4-3a47-a4a0-10ae138d0c1g
write /dev/stdout: broken pipe
Terminated
As you can see from the output above, the feeder-id given to us from FlightAware is acbf1f88-09a4-3a47-a4a0-10ae138d0c1g.
You'll now want to "claim" this feeder.
To do this, go to: FlightAware PiAware Claim and follow the instructions there.
docker run \
-d \
--rm \
--name piaware \
--device /dev/bus/usb \
-e TZ="Australia/Perth" \
-e FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37 \
-e RECEIVER_TYPE=rtlsdr \
-p 8080:80 \
--tmpfs=/run:exec,size=64M \
--tmpfs=/var/log \
ghcr.io/sdr-enthusiasts/docker-piaware:latestversion: "2.0"
services:
piaware:
image: ghcr.io/sdr-enthusiasts/docker-piaware:latest
tty: true
container_name: piaware
restart: always
devices:
- /dev/bus/usb:/dev/bus/usb
ports:
- 8080:80
- 30003:30003
- 30005:30005
environment:
- TZ="Australia/Perth"
- FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37
- RECEIVER_TYPE=rtlsdr
tmpfs:
- /run:exec,size=64M
- /var/logThis will currently only work in the United States of America, as they are the only country that uses ADS-B UAT on 978MHz.
This example assumes that:
- Your 1090MHz RTL-SDR has its serial set to
00001090 - Your 978MHz RTL-SDR has its serial set to
00000978
docker run \
-d \
--rm \
--name piaware \
--device /dev/bus/usb \
-e TZ="Australia/Perth" \
-e RECEIVER_TYPE=rtlsdr \
-e DUMP1090_DEVICE=00001090 \
-e UAT_RECEIVER_TYPE=rtlsdr \
-e DUMP978_DEVICE=00000978 \
-e FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37 \
-p 8080:80 \
--tmpfs=/run:exec,size=64M \
--tmpfs=/var/log \
ghcr.io/sdr-enthusiasts/docker-piaware:latestThis will currently only work in the United States of America, as they are the only country that uses ADS-B UAT on 978MHz.
version: "2.0"
services:
piaware:
image: ghcr.io/sdr-enthusiasts/docker-piaware:latest
tty: true
container_name: piaware
restart: always
devices:
- /dev/bus/usb:/dev/bus/usb
ports:
- 8080:80
- 30003:30003
- 30005:30005
environment:
- TZ="Australia/Perth"
- FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37
- RECEIVER_TYPE=rtlsdr
- DUMP1090_DEVICE=00001090
- UAT_RECEIVER_TYPE=rtlsdr
- DUMP978_DEVICE=00000978
tmpfs:
- /run:exec,size=64M
- /var/logAn example of an external Mode-S/BEAST provider would be:
sdr-enthusiasts/docker-readsb-protobufcontainer- Another hardware feeder that provides BEAST output data on port 30005
In the example below, it is assumed that the external BEAST provider resolves to beasthost and is listening for connections on TCP port 30005.
docker run \
-d \
--rm \
--name piaware \
-e TZ="Australia/Perth" \
-e RECEIVER_TYPE=relay \
-e BEASTHOST=beasthost \
-e BEASTPORT=30005 \
-e FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37 \
--tmpfs=/run:exec,size=64M \
--tmpfs=/var/log \
ghcr.io/sdr-enthusiasts/docker-piaware:latestAn example of an external Mode-S/BEAST provider would be:
sdr-enthusiasts/docker-readsb-protobufcontainer- Another hardware feeder that provides BEAST output data on port 30005
In the example below, it is assumed that the external BEAST provider resolves to beasthost and is listening for connections on TCP port 30005.
version: "2.0"
services:
piaware:
image: ghcr.io/sdr-enthusiasts/docker-piaware:latest
tty: true
container_name: piaware
restart: always
environment:
- TZ="Australia/Perth"
- RECEIVER_TYPE=relay
- BEASTHOST=beasthost
- BEASTPORT=30005
- FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37
tmpfs:
- /run:exec,size=64M
- /var/logThis will currently only work in the United States of America, as they are the only country that uses ADS-B UAT on 978MHz.
An example of an external Mode-S/BEAST provider would be:
sdr-enthusiasts/docker-readsb-protobufcontainer- Another hardware feeder that provides BEAST output data on port 30005
In the example below, it is assumed that the external BEAST provider resolves to beasthost and is listening for connections on TCP port 30005.
An example of an external UAT provider would be:
sdr-enthusiasts/docker-dump978container
In the example below, it is assumed that the external UAT provider resolves to uathost and is listening for connections on TCP port 30978.
docker run \
-d \
--rm \
--name piaware \
-e TZ="Australia/Perth" \
-e RECEIVER_TYPE=relay \
-e BEASTHOST=beasthost \
-e BEASTPORT=30005
-e UAT_RECEIVER_TYPE=relay \
-e UAT_RECEIVER_HOST=uathost \
-e UAT_RECEIVER_PORT=30978 \
-e FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37 \
--tmpfs=/run:exec,size=64M \
--tmpfs=/var/log \
ghcr.io/sdr-enthusiasts/docker-piaware:latestThis will currently only work in the United States of America, as they are the only country that uses ADS-B UAT on 978MHz.
An example of an external Mode-S/BEAST provider would be:
sdr-enthusiasts/docker-readsb-protobufcontainer- Another hardware feeder that provides BEAST output data on port 30005
In the example below, it is assumed that the external BEAST provider resolves to beasthost and is listening for connections on TCP port 30005.
An example of an external UAT provider would be:
sdr-enthusiasts/docker-dump978container
In the example below, it is assumed that the external UAT provider resolves to uathost and is listening for connections on TCP port 30978.
version: "2.0"
services:
piaware:
image: ghcr.io/sdr-enthusiasts/docker-piaware:latest
tty: true
container_name: piaware
restart: always
environment:
- TZ="Australia/Perth"
- RECEIVER_TYPE=relay
- BEASTHOST=beasthost
- BEASTPORT=30005
- UAT_RECEIVER_TYPE=relay
- UAT_RECEIVER_HOST=uathost
- UAT_RECEIVER_PORT=30978
- FEEDER_ID=c478b1c99-23d3-4376-1f82-47352a28cg37
tmpfs:
- /run:exec,size=64M
- /var/logFor an explanation of piaware-config variables, see FlightAware PiAware Advanced Configuration.
| Environment Variable | Purpose | Default |
|---|---|---|
TZ |
Local timezone in "TZ database name" format. | UTC |
FEEDER_ID |
Your FlightAware feeder ID (required) | |
BINGMAPSAPIKEY |
Optional. Bing Maps API Key. If set, it is configured in dump1090's config.js. |
|
VERBOSE_LOGGING |
Optional. Set to true for more verbose logs. |
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
ALLOW_MLAT |
yes or no |
If yes, multilateration is enabled (also requires that receiver location is set on the FlightAware My ADS-B stats page) |
yes |
MLAT_RESULTS |
yes or no |
If yes, multilateration results are returned to PiAware from FlightAware |
yes |
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
ALLOW_MODEAC |
yes or no |
If yes, piaware and dump1090-fa will enable Mode A/C decoding if a client requests it. |
|
| Mode A/C decoding requires additional CPU when enabled. | yes |
||
RECEIVER_TYPE |
rtlsdr, relay |
Configures how PiAware attempts to talk to the ADS-B receiver | rtlsdr |
Receiver types:
rtlsdr- For FlightAware dongles and any other RTL-SDRrelay- For use with an external BEAST protocol provider running on another host (dump1090/readsb/etc)bladerf/hackrf/limesdr/radarcape- Support for these is compiled in, but I need to complete the wrapperr scripts. I don't have access to these devices. If you do, and would be willing to test, please get in touch with me!
Use only with RECEIVER_TYPE=rtlsdr.
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
RTLSDR_PPM |
a frequency correction in PPM | Configures the dongle PPM correction | 0 |
RTLSDR_GAIN |
max or a numeric gain level |
Optimizing gain (optional) -- See FlightAware -- Optimizing Gain | max |
DUMP1090_DEVICE |
rtlsdr device serial number | Configures which dongle to use for 1090MHz reception if there is more than one connected | first available device |
The following settings control the adaptive gain configuration of dump1090 when using RECEIVER_TYPE=rtlsdr.
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
DUMP1090_ADAPTIVE_RANGE |
true or unset |
Set to any value to adjust gain for target dynamic range. | |
DUMP1090_ADAPTIVE_RANGE_TARGET |
A value in dB | Set target dynamic range in dB. | |
DUMP1090_ADAPTIVE_BURST |
true or unset |
Set to any value to adjust gain for too-loud message bursts. | |
DUMP1090_ADAPTIVE_MIN_GAIN |
A value in dB | Set gain adjustment range lower limit (dB). | |
DUMP1090_ADAPTIVE_MAX_GAIN |
A value in dB | Set gain adjustment range upper limit (dB). | |
DUMP1090_ADAPTIVE_DUTY_CYCLE |
A percentage | Set adaptive gain duty cycle % (1..100) See Reducing the CPU cost of adaptive gain |
Use only with RECEIVER_TYPE=relay.
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
BEASTHOST |
a hostname or IP | Specify an external BEAST protocol provider (dump1090/readsb/etc). | |
BEASTPORT |
a port number | Specify the TCP port number of the external BEAST protocol provider. | 30005 |
MLAT_RESULTS_BEASTHOST |
a hostname or IP | Specify an external host where MLAT results should be sent. | |
MLAT_RESULTS_BEASTPORT |
a port number | Specify the TCP port number where MLAT results should be sent. | 30104 |
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
UAT_RECEIVER_TYPE |
none, rtlsdr, relay |
Configures how PiAware attempts to talk to the ADS-B receiver | none |
Receiver types:
rtlsdr- For FlightAware dongles and any other RTL-SDRrelay- For use with an external BEAST protocol provider running on another host (dump1090/readsb/etc)bladerf/hackrf/limesdr/radarcape- Support for these is compiled in, but I need to complete the wrapperr scripts. I don't have access to these devices. If you do, and would be willing to test, please get in touch with me!
Use only with UAT_RECEIVER_TYPE=rtlsdr.
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
DUMP978_DEVICE |
rtlsdr device serial number | Configures which dongle to use for 978MHz reception if there is more than one connected | first available device |
UAT_SDR_GAIN |
max or a numeric gain level |
Optimizing gain (optional) -- See FlightAware -- Optimizing Gain | max |
UAT_SDR_PPM |
a frequency correction in PPM | Configures the dongle PPM correction | 0 |
Use only with UAT_RECEIVER_TYPE=relay.
| Environment Variable | Possible Values | Description | Default |
|---|---|---|---|
UAT_RECEIVER_HOST |
a hostname or IP | Specify an external UAT raw data provider (dump978-fa). | |
UAT_RECEIVER_PORT |
a port number | Specify the TCP port number of the external UAT raw data provider. | 30978 |
The following ports are used by this container:
80- PiAware Status page and dump1090 web interface (Skyaware) - optional but recommended so you can check status and and watch the planes fly around.30003- dump1090 TCP BaseStation output listen port - optional, recommended to leave unmapped unless explicitly needed30005- dump1090 TCP Beast output listen port - optional, recommended to leave unmapped unless explicitly needed30105- If MLAT is enabled,mlat-clientresults published on this port in Beast format - optional, recommended to leave unmapped unless explicitly needed30978- If UAT decoding is enabled, UAT raw data published on this port - optional, recommended to leave unmapped unless explicitly needed30979- If UAT decoding is enabled, UAT decoded JSON published on this port - optional, recommended to leave unmapped unless explicitly needed
Since version 3.8.0 the flightaware-user and flightaware-password configuration options are no longer used; please use the normal site-claiming mechanisms to associate sites with a FlightAware account.
- All processes are logged to the container's stdout, and can be viewed with
docker logs [-f] container. lighttpd(which provides SkyAware & SkyAware978) is configured to not log (except for a startup message on container start)
Check out these other images here.
Please feel free to open an issue on the project's GitHub.
We also have a Discord channel, feel free to join and converse.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent