Code Monkey home page Code Monkey logo

docker-tar1090's Introduction

mikenye/tar1090

tar1090 is an excellent tool by wiedehopf that provides an improved dump1090-fa interface.

At the time of writing this README, it provides:

  • Improved adjustable history
  • Show All Tracks much faster than original with many planes
  • Multiple Maps available
  • Map can be dimmed/darkened
  • Multiple aircraft can be selected
  • Labels with the callsign can be switched on and off
  • Heatmap of aircraft positions

This image:

  • Receives Beast data from a provider such as dump1090 or readsb
  • Optionally, receives MLAT data from a provider such as mlat-client
  • Provides the tar1090 web interface
  • Provides the timelapse1090 web interface

It builds and runs on linux/amd64, linux/arm/v7 and linux/arm64 (see below).

Supported tags and respective Dockerfiles

  • latest should always contain the latest released versions of readsb, tar1090 and tar1090-db. This image is built nightly from the master branch Dockerfile for all supported architectures.
  • latest_nohealthcheck is the same as the latest version above. However, this version has the docker healthcheck removed. This is done for people running platforms (such as Nomad) that don't support manually disabling healthchecks, where healthchecks are not wanted.
  • Specific version tags are available if required, however these are not regularly updated. It is generally recommended to run latest.

Multi Architecture Support

  • linux/amd64: Built on Linux x86-64
  • linux/arm/v6: Built on Odroid HC2 running ARMv7 32-bit
  • linux/arm/v7: Built on Odroid HC2 running ARMv7 32-bit
  • linux/arm64: Built on a Raspberry Pi 4 Model B running ARMv8 64-bit

Prerequisites

You will need a source of Beast data. This could be an RPi running PiAware, the mikenye/piaware image or mikenye/readsb.

Optionally, you will need a source of MLAT data. This could be:

Up-and-Running with docker run

docker run -d \
    --name=tar1090 \
    -p 8078:80 \
    -e TZ=<TIMEZONE> \
    -e BEASTHOST=<BEASTHOST> \
    -e MLATHOST=<MLATHOST> \
    -e LAT=xx.xxxxx \
    -e LONG=xx.xxxxx \
    --tmpfs=/run:exec,size=64M \
    --tmpfs=/var/log \
    mikenye/tar1090:latest

Replacing TIMEZONE with your timezone, BEASTHOST with the IP address of a host that can provide Beast data, and MLATHOST with the IP address of a host that can provide MLAT data.

For example:

docker run -d \
    --name=tar1090 \
    -p 8078:80 \
    -e TZ=Australia/Perth \
    -e BEASTHOST=readsb \
    -e MLATHOST=adsbx \
    -e LAT=-33.33333 \
    -e LONG=111.11111 \
    --tmpfs=/run:exec,size=64M \
    --tmpfs=/var/log \
    mikenye/tar1090:latest

You should now be able to browse to:

Up-and-Running with docker-compose

An example docker-compose.xml file is below:

version: '2.0'

networks:
  adsbnet:

services:

  tar1090:
    image: mikenye/tar1090:latest
    tty: true
    container_name: tar1090
    restart: always
    environment:
      - TZ=Australia/Perth
      - BEASTHOST=readsb
      - MLATHOST=adsbx
      - LAT=-33.33333
      - LONG=111.11111
    networks:
      - adsbnet
    ports:
      - 8078:80
    tmpfs:
      - /run:exec,size=64M
      - /var/log

You should now be able to browse to:

Note: the example above excludes MLATHOST as readsb alone cannot provide MLAT data. You'll need a feeder container for this.

Ports

Outgoing

This container will try to connect to the BEASTHOST on TCP port 30005 by default. This can be changed by setting the BEASTPORT environment variable.

If MLATHOST is set, this container will try to connecto the MLATHOST on TCP port 30105 by default. This can be changed to setting the MLATPORT environment variable.

Incoming

This container accepts HTTP connections on TCP port 80 by default. You can change this with the container's port mapping. In the examples above, this has been changed to 8078.

Runtime Environment Variables

Container Configuration

Environment Variable Purpose Default
BEASTHOST Required. IP/Hostname of a Mode-S/Beast provider (dump1090/readsb)
BEASTPORT Optional. TCP port number of Mode-S/Beast provider (dump1090/readsb) 30005
LAT Optional. The latitude of your antenna
LONG Optional. The longitude of your antenna
MLATHOST Optional. IP/Hostname of an MLAT provider (mlat-client)
MLATPORT Optional. TCP port number of an MLAT provider (mlat-client) 30105
TZ Optional. Your local timezone in TZ-database-name format
HEYWHATSTHAT_PANORAMA_ID Optional. Your heywhatsthat.com panorama ID. See https://github.com/wiedehopf/tar1090#heywhatsthatcom-range-outline.
HTTP_ACCESS_LOG Optional. Set to true to display HTTP server access logs. false
HTTP_ERROR_LOG Optional. Set to false to hide HTTP server error logs. true
READSB_MAX_RANGE Optional. Maximum range (in nautical miles). 300
ENABLE_TIMELAPSE1090 Optional. Set to any value to enable timelapse1090. Once enabled, can be accessed via http://dockerhost:port/timelapse/. Unset
READSB_EXTRA_ARGS Optional, allows to specify extra parameters for readsb, for example --write-json-globe-index --write-globe-history /var/globe_history would cause traces being saved to disk and tar1090 similar to globe.adsbexchange.com Unset
S6_SERVICES_GRACETIME Optional, set to 30000 when saving traces / globe_history 3000

tar1090 Configuration

All of the variables below are optional.

tar1090 Core Configuration

Environment Variable Purpose Default
UPDATE_TAR1090 At startup update tar1090 and tar1090db to the latest versions true
INTERVAL Interval at which the track history is saved 8
HISTORY_SIZE How many points in time are stored in the track history 450
ENABLE_978 Change to yes to enable UAT/978 display in tar1090 no
URL_978 The URL needs to point at where you would normally find the skyview978 webinterface http://127.0.0.1/skyaware978
GZIP_LVL 1-9 are valid, lower lvl: less CPU usage, higher level: less network bandwidth used when loading the page 3
PTRACKS Shows the last $PTRACKS hours of traces you have seen at the ?pTracks URL 8
TAR1090_FLIGHTAWARELINKS Set to any value to enable FlightAware links in the web interface null
TAR1090_ENABLE_AC_DB Set to true to enable extra information, such as aircraft type and registration, to be included in in aircraft.json output. Will use more memory; use caution on older Pis or similiar devices. false

tar1090 config.js Configuration - Title

Environment Variable Purpose Default
TAR1090_PAGETITLE Set the tar1090 web page title tar1090
TAR1090_PLANECOUNTINTITLE Show number of aircraft in the page title false
TAR1090_MESSAGERATEINTITLE Show number of messages per second in the page title false

tar1090 config.js Configuration - Output

Environment Variable Purpose Default
TAR1090_DISPLAYUNITS The DisplayUnits setting controls whether nautical (ft, NM, knots), metric (m, km, km/h) or imperial (ft, mi, mph) units are used in the plane table and in the detailed plane info. Valid values are "nautical", "metric", or "imperial". nautical

tar1090 config.js Configuration - Map Settings

Environment Variable Purpose Default
TAR1090_BINGMAPSAPIKEY Provide a Bing Maps API key to enable the Bing imagery layer. You can obtain a free key (with usage limits) at https://www.bingmapsportal.com/ (you need a "basic key"). null
TAR1090_DEFAULTCENTERLAT Default center (latitude) of the map. This setting is overridden by any position information provided by dump1090/readsb. All positions are in decimal degrees. 45.0
TAR1090_DEFAULTCENTERLON Default center (longitude) of the map. This setting is overridden by any position information provided by dump1090/readsb. All positions are in decimal degrees. 9.0
TAR1090_DEFAULTZOOMLVL The google maps zoom level, 0 - 16, lower is further out. 7
TAR1090_SITESHOW Center marker. If dump1090 provides a receiver location, that location is used and these settings are ignored. Set to true to show a center marker. false
TAR1090_SITELAT Center marker. If dump1090 provides a receiver location, that location is used and these settings are ignored. Position of the marker (latitude). 45.0
TAR1090_SITELON Center marker. If dump1090 provides a receiver location, that location is used and these settings are ignored. Position of the marker (longitude). 9.0
TAR1090_SITENAME The tooltip of the center marker. My Radar Site
TAR1090_RANGE_OUTLINE_COLOR Colour for the range outline. #0000DD
TAR1090_RANGE_OUTLINE_WIDTH Width for the range outline. 1.7
TAR1090_RANGE_OUTLINE_COLORED_BY_ALTITUDE Range outline is coloured by altitude. false
TAR1090_RANGE_OUTLINE_DASH Range outline dashing. Syntax [L, S] where L is the pixel length of the line, and S is the pixel length of the space. Unset
TAR1090_ACTUAL_RANGE_OUTLINE_COLOR Colour for the actual range outline #00596b
TAR1090_ACTUAL_RANGE_OUTLINE_WIDTH Width of the actual range outline 1.7
TAR1090_ACTUAL_RANGE_OUTLINE_DASH Dashed style for the actual range outline. Unset for solid line. [5,5] for a dashed line with 5 pixel lines and spaces in between Unset
TAR1090_MAPTYPE_TAR1090 Which map is displayed to new visitors. Valid values for this setting are osm, esri, carto_light_all, carto_light_nolabels, carto_dark_all, carto_dark_nolabels, gibs, osm_adsbx, chartbundle_sec, chartbundle_tac, chartbundle_hel, chartbundle_enrl, chartbundle_enra, chartbundle_enrh, and only with bing key bing_aerial, bing_roads. carto_light_all
TAR1090_MAPDIM Default map dim state, true or false. true
TAR1090_MAPDIMPERCENTAGE The percentage amount of dimming used if the map is dimmed, 0-1 0.45
TAR1090_MAPCONTRASTPERCENTAGE The percentage amount of contrast used if the map is dimmed, 0-1 0
TAR1090_LABELZOOM Displays aircraft labels only until this zoom level, 1-15 (values >15 don't really make sense)
TAR1090_LABELZOOMGROUND Displays ground traffic labels only until this zoom level, 1-15 (values >15 don't really make sense)

tar1090 config.js Configuration - Range Rings

Environment Variable Purpose Default
TAR1090_RANGERINGS false to hide range rings true
TAR1090_RANGERINGSDISTANCES Distances to display range rings, in miles, nautical miles, or km (depending settings value 'TAR1090_DISPLAYUNITS'). Accepts a comma separated list of numbers (no spaces, no quotes). 100,150,200,250
TAR1090_RANGERINGSCOLORS Colours for each of the range rings specified in TAR1090_RANGERINGSDISTANCES. Accepts a comma separated list of hex colour values, each enclosed in single quotes (eg TAR1090_RANGERINGSCOLORS='#FFFFF','#00000'). No spaces. Blank

timelapse1090 Configuration

Environment Variable Purpose Default
TIMELAPSE1090_INTERVAL Snapshot interval in seconds 10
TIMELAPSE1090_HISTORY Time saved in hours 24

Paths

No paths need to be mapped through to persistent storage. However, if you don't want to lose your range outline and aircraft tracks/history on container restart, you can optionally map these paths:

Path Purpose
/var/globe_history Holds range outline data, heatmap data and traces if enabled
/var/timelapse1090 Holds data for timelapse1090 if enabled

Logging

All logs are to the container's stdout and can be viewed with docker logs [-f] container.

Getting help

Please feel free to open an issue on the project's GitHub.

I also have a Discord channel, feel free to join and converse.

Changelog

See the GitHub commit log.

docker-tar1090's People

Contributors

76rhodan avatar dependabot[bot] avatar fredclausen avatar mikenye avatar wiedehopf avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.