Skip to content

Latest commit

 

History

History
77 lines (60 loc) · 6.83 KB

README.md

File metadata and controls

77 lines (60 loc) · 6.83 KB
Raw

Docker dumpvdl2

Banner GitHub Workflow Status Docker Pulls Docker Image Size (tag) Discord

Docker container for running dumpvdl2 and forwarding the received JSON messages to another system or docker container. Best used alongside ACARS Hub.

Builds and runs on amd64, arm64.

Please note: DUE TO LIBSDRPLAY, THIS CONTAINER WILL NOT RUN ON ARM32 DEVICES

Required hardware

A computer host on a suitable architecture and one USB RTL-SDR dongle connected to an antenna.

Deprecation Notice

SERIAL has been deprecated in favor of SOAPYSDR. Please update your configuration accordingly. If SERIAL is set the driver will be set to rtlsdr and the serial number will be set to the value of SERIAL.

Up and running

version: "2.0"

services:
  dumpvdl2:
    image: ghcr.io/sdr-enthusiasts/docker-dumpvdl2:latest
    container_name: dumpvdl2
    restart: always
    ports:
    environment:
      - TZ="America/Denver"
      - SOAPYSDR=driver=rtlsdr,serial=13305
      - FEED_ID=VDLM
      - FREQUENCIES=136725000;136975000;136875000
      - ZMQ_MODE=server
      - ZMQ_ENDPOINT=tcp://0.0.0.0:45555
    tmpfs:
      - /run:exec,size=64M
      - /var/log
    device_cgroup_rules:
      - 'c 189:* rwm'
    volumes:
      - /dev/bus/usb:/dev/bus/usb:ro

Configuration options

Variable Description Required Default
TZ Your timezone No UTC
SOAPYSDR The SoapySDR device string that identifies your dongle. See below for supported soapy sdr types. No Blank
FEED_ID Used by the decoder to insert a unique ID in to the output message Yes Blank
FREQUENCIES Semicolon-separated list of frequencies for the decoder to listen to. All frequencies should either be in Hz, or in MHz with exactly 3 digits after the decimal point. Yes Blank
PPM Parts per million correction of the decoder No 0
GAIN The gain applied to the RTL-SDR dongle. No 40
OVERSAMPLE Overrides the default oversampling rate used by dumpvdl2. No Blank
VDLM_FILTER_ENABLE Filter out non-informational messages. Turning this off (set to a blank value) will cause increased message rate but the messages will be of little value. Will cause extra SD card read/writes. No TRUE
VDLM_FILTER Specify the dumpvdl2 filter string. Used it VDLM_FILTER_ENABLE is true. No all,-avlc_s,-acars_nodata,-x25_control,-idrp_keepalive,-esis
QUIET_LOGS Mute log output to the bare minimum. Set to false to disable. No TRUE
ZMQ_MODE Output to zmq publisher socket. This sets the mode to client or server. No
ZMQ_ENDPOINT Output to zmq publisher socket. This sets the endpoint. Syntax is tcp://address:port No
STATSD_SERVER Output to a statsd instance. No unset

SoapySDR device string

The SoapySDR device string is used to identify your RTL-SDR dongle. The default value is driver=rtlsdr which is suitable for most users. If you are using a different SDR, you will need to provide the correct device string. For example, if you are using an Airspy Mini, you would set SOAPYSDR=driver=airspy. Pass any additional options for the SDR in via this option as well.

Supported Soapy Drivers:

  • rtlsdr
  • rtltcp
  • airspy
  • sdrplay