1
0
Fork 0
mirror of https://github.com/sdr-enthusiasts/docker-adsb-ultrafeeder.git synced 2024-11-22 13:50:14 +00:00

update documentation

This commit is contained in:
kx1t 2023-05-18 15:30:11 -04:00
parent d72f08831b
commit 53ccf2bc1a
2 changed files with 23 additions and 1 deletions

View file

@ -17,6 +17,7 @@
- [Connecting to external ADSB data sources](#connecting-to-external-adsb-data-sources) - [Connecting to external ADSB data sources](#connecting-to-external-adsb-data-sources)
- [All-in-One Configuration using `ULTRAFEEDER_CONFIG`](#all-in-one-configuration-using-ultrafeeder_config) - [All-in-One Configuration using `ULTRAFEEDER_CONFIG`](#all-in-one-configuration-using-ultrafeeder_config)
- [Networking parameters](#networking-parameters) - [Networking parameters](#networking-parameters)
- [Feeding directly from Ultrafeeder](#feeding-directly-from-ultrafeeder)
- [Alternate Configuration Method with `READSB_NET_CONNECTOR`](#alternate-configuration-method-with-readsb_net_connector) - [Alternate Configuration Method with `READSB_NET_CONNECTOR`](#alternate-configuration-method-with-readsb_net_connector)
- [Optional Networking Parameters](#optional-networking-parameters) - [Optional Networking Parameters](#optional-networking-parameters)
- [MLAT configuration](#mlat-configuration) - [MLAT configuration](#mlat-configuration)
@ -265,7 +266,7 @@ docker exec -it ultrafeeder /usr/local/bin/autogain1090 reset
#### Connecting to external ADSB data sources #### Connecting to external ADSB data sources
In addition to (or instead of) connecting to a SDR or hardware device to get ADSB data, the container also supports ingesting data from a TCP port. Here are some parameters that you need to configure if you want to make this happen: In addition to (or instead of) connecting to a SDR or hardware device to get ADSB data, the container also supports ingesting or sending data from a TCP port. Here are some parameters that you need to configure if you want to make this happen:
##### All-in-One Configuration using `ULTRAFEEDER_CONFIG` ##### All-in-One Configuration using `ULTRAFEEDER_CONFIG`
@ -316,6 +317,26 @@ In the above configuration strings:
| `MLATHOST` | Legacy parameter. IP/Hostname of an MLAT provider (`mlat-client`). Note - using this parameter will not make the MLAT data part of the consolidated mlathub. The preferred way of ingesting MLAT results is using the `mlathub` functionality of the container, see below for details | | | `MLATHOST` | Legacy parameter. IP/Hostname of an MLAT provider (`mlat-client`). Note - using this parameter will not make the MLAT data part of the consolidated mlathub. The preferred way of ingesting MLAT results is using the `mlathub` functionality of the container, see below for details | |
| `MLATPORT` | Legacy parameter used with `MLATHOST`. TCP port number of an MLAT provider (`mlat-client`) | 30105 | | `MLATPORT` | Legacy parameter used with `MLATHOST`. TCP port number of an MLAT provider (`mlat-client`) | 30105 |
##### Feeding directly from Ultrafeeder
There are several aggregators, both non-profit and commercial, that can directly be sent data from ultrafeeder without the need for an additional feeder container. We have added them in the example `docker-compose.yml` snippet above. Here is a partial list of these aggregators:
| Name | (C)ommercial/(N)on-profit | Description | Feed details |
|------|---------------------------|-------------|--------------|
| ADSB.fi | N | Run by volunteers that used to be related to adsbexchange | adsb:`feed.adsb.fi` port `tcp/30004`, format `beast_reduce_plus_out`<br/>mlat: `feed.adsb.fi` port `tcp/31090`, format `mlat-client`|
|------|---------------------------|-------------|--------------|
| ADSB.one | N | Run by volunteers that used to be related to adsbexchange | adsb:`feed.adsb.one` port `tcp/60004`, format `beast_reduce_plus_out`<br/>mlat: `feed.adsb.one` port `tcp/64006`, format `mlat-client`|
|------|---------------------------|-------------|--------------|
| ADSB.lol | N | Run by a private individual located in the Netherlands | adsb:`in.adsb.lol` port `tcp/30004`, format `beast_reduce_plus_out`<br/>mlat: `in.adsb.one` port `tcp/31090`, format `mlat-client`|
|------|---------------------------|-------------|--------------|
| Planespotters | N | planespotters.net | adsb:`feed.planespotters.net` port `tcp/30004`, format `beast_reduce_plus_out`<br/>mlat: `mlat.planespotters.net` port `tcp/31090`, format `mlat-client`|
|------|---------------------------|-------------|--------------|
| The Air Traffic | N | Run by a private individual | adsb:`feed.theairtraffic.com` port `tcp/30004`, format `beast_reduce_plus_out`<br/>mlat: `mlat.theairtraffic.com` port `tcp/31090`, format `mlat-client`|
|------|---------------------------|-------------|--------------|
| AV Delphi | C | Swiss aircraft data company | adsb:`data.avdelphi.com` port `tcp/24999`, format `beast_reduce_plus_out`<br/>mlat: no MLAT|
|------|---------------------------|-------------|--------------|
| ADSB Exchange | C | Large aggregator owned by JetNet | adsb:`feed1.adsbexchange.com` port `tcp/30004`, format `beast_reduce_plus_out`<br/>mlat: `feed.adsbexchange.com` port `tcp/31090`, format `mlat-client`|
##### Alternate Configuration Method with `READSB_NET_CONNECTOR` ##### Alternate Configuration Method with `READSB_NET_CONNECTOR`
Instead of (or in addition to) using `BEASTHOST`, you can also define ADSB data ingests using the `READSB_NET_CONNECTOR` parameter. This is the preferred way if you have multiple sources or destinations for your ADSB data. This variable allows you to configure incoming and outgoing connections. The variable takes a semicolon (`;`) separated list of `host,port,protocol[,uuid=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]`, see the section [All-in-One Configuration using `ULTRAFEEDER_CONFIG`](#all-in-one-configuration-using-ultrafeeder_config) for explanation of these parameters. Instead of (or in addition to) using `BEASTHOST`, you can also define ADSB data ingests using the `READSB_NET_CONNECTOR` parameter. This is the preferred way if you have multiple sources or destinations for your ADSB data. This variable allows you to configure incoming and outgoing connections. The variable takes a semicolon (`;`) separated list of `host,port,protocol[,uuid=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX]`, see the section [All-in-One Configuration using `ULTRAFEEDER_CONFIG`](#all-in-one-configuration-using-ultrafeeder_config) for explanation of these parameters.

View file

@ -46,6 +46,7 @@ services:
adsb,feed.adsb.one,64004,beast_reduce_plus_out; adsb,feed.adsb.one,64004,beast_reduce_plus_out;
adsb,feed.planespotters.net,30004,beast_reduce_plus_out; adsb,feed.planespotters.net,30004,beast_reduce_plus_out;
adsb,feed.theairtraffic.com,30004,beast_reduce_plus_out; adsb,feed.theairtraffic.com,30004,beast_reduce_plus_out;
adsb,data.avdelphi.com,24999,beast_reduce_plus_out;
mlat,feed.adsb.fi,31090,39000; mlat,feed.adsb.fi,31090,39000;
mlat,in.adsb.lol,31090,39001; mlat,in.adsb.lol,31090,39001;
mlat,feed.adsb.one,64006,39002; mlat,feed.adsb.one,64006,39002;