diff --git a/README.md b/README.md index a3bcb0c..efa1638 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ By default, it feeds MLAT+ADSB to adsb.lol. You can enable UAT/ACARS/VDL2, and f It is designed to be run on a Raspberry Pi, but can be run on any Linux Debian-like system. -With [a few commands](#feeding-directly-to-other-aggregators), you can easily feed to other community aggregators. +With a few commands, you can easily feed to other community aggregators. + +For an up to date version of the documentation, see [www.adsb.lol/feed/docker](https://www.adsb.lol/feed/docker/). ## Bare metal install @@ -21,124 +23,6 @@ Run: ``` curl -fsL -o /tmp/adsblol.sh https://adsb.lol/feed.sh && sudo bash /tmp/adsblol.sh ``` - -## Quick Start docker - -To get started with the docker client, - -Run this **as root** on a fresh install of Raspberry Pi OS Lite or similar. - -This script gets all the requirements for your system. - -**For your own security,** Please consider [analysing](https://github.com/adsblol/feed/blob/main/bin/adsblol-init) the `adsblol-init` script which you are about to run on your system. - -``` -curl -Ls https://raw.githubusercontent.com/adsblol/feed/main/bin/adsblol-init | bash -cd /opt/adsblol/ -cp .env.example .env -``` - -Then, set the environment variables. - -You can either edit the `.env` file, or run `adsblol-env set ` - -``` -# Altitude in meters -adsblol-env set FEEDER_ALT_M 542 -# Latitude -adsblol-env set FEEDER_LAT 98.76543 -# Longitude -adsblol-env set FEEDER_LONG 12.34567 -# Timezone (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) -adsblol-env set FEEDER_TZ America/New_York -# SDR Serial Number -adsblol-env set ADSB_DONGLE_SERIAL 1090 -# Site name (shows up on the MLAT map!) -adsblol-env set MLAT_SITE_NAME "My epic site" -# Would you like to appear on map.adsb.lol? Then set this: -adsblol-env unset ADSBLOL_MLAT_CONFIG -``` - -These are the minimum environment variables you need to set. - -Then, run: -``` -adsblol-debug && adsblol-up -``` -Let's check if everything is working: - -- [ ] (readsb) -- [ ] (adsblol) -- [ ] (ADSB) -- [ ] (MLAT) - -## Usage - -By default, the client will feed to adsb.lol. - -To see the current list of supported aggregators, see the [services.txt](services.txt) file. - -The `adsblol` service supports feeding to multiple aggregators. - -If you have an issue with the feed client, please [paste.ee](https://paste.ee) your error logs join our chat on [matrix](https://matrix.to/#/#adsblol:gatto.club) or [discord](https://adsb.lol/discord). - - -### Restart the stack - -``` -adsblol-up -``` - -## Enabling a service - -To enable a service, run `adsblol-service enable ` -To disable a service, run `adsblol-service disable ` -This is a helper command that will edit the `services.txt` file, and run `adsblol-gen` to generate a new `cmdline.txt`. - -You may have to define further environment variables in the `.env` file. - -Once you have done this, run `adsblol-up` to start the containers. - -## Troubleshooting - -To update, run `adsblol-update` - -Running `adsblol-debug` will tell you about common mistakes. - -### I cannot find myself on the MLAT Map - -adsb.lol enables the `--privacy` flag for your MLAT client by default. -This hides you from the MLAT map. - -Do you want to appear on the map? Then run: - -``` -adsblol-env unset ADSBLOL_MLAT_CONFIG && adsblol-up -``` - -### Logs - -- `adsblol-logs` - view logs -- `adsblol-logs -f` - view logs and follow - -### Services -- `adsblol-service enable ` - enable a service -- `adsblol-service disable ` - disable a service -- `adsblol-service list` - list all enabled services - -### Environment -- `adsblol-env list` - list all environment variables -- `adsblol-env set ` - set an environment variable (also updates if it already exists) -- `adsblol-env unset ` - unset an environment variable - -### SDR -- `adsblol-sdr test` - Runs rtl_test -- `adsblol-sdr dockertest` - Runs rtl_test in a docker container -- `adsblol-sdr dockerppm` - Runs rtl_test in a docker container with the intent to estimate the PPM - -### Reset -- `adsblol-reset` - reset the /opt/adsblol directory - ## Thank you SDR-Enthusiasts! This would not be possible without [SDR-Enthusiasts](https://github.com/sdr-enthusiasts/) who have made [the original docker-compose](https://github.com/sdr-enthusiasts/docker-install) file. @@ -146,33 +30,3 @@ This would not be possible without [SDR-Enthusiasts](https://github.com/sdr-enth This repo is largely based off of their work plus some command line interface tools to make running the stack a bit simpler. [Their documentation can be very useful in enabling extra feeders.](https://sdr-enthusiasts.gitbook.io/ads-b/feeder-containers/feeding-flightaware-piaware). - - -## Feeding directly to other aggregators - -Where possible, adsb.lol commits to share data and ingest data directly with other aggregators which are willing to license their data openly. - -The `adsblol` service can feed to other aggregators. - -In this example, we feed [theairtraffic.com](https://theairtraffic.com) and [adsbexchange.com](https://adsbexchange.com) -two aggregators you might want to consider sharing your data with. - -ADSBexchange has the largest network of MLAT receivers at the time of writing, so you have the highest chance of getting local flights that you might miss as they do not transfer their location data. - -This is not an endorsement and adsb.lol is not affiliated with these aggregators. - -### Run - -**NOTE:** This is using `--privacy`, which excludes you from adsb.lol map, and should exclude you from other aggregators maps too. - -``` -adsblol-env set ADSBLOL_ADDITIONAL_NET_CONNECTOR "feed.adsbexchange.com,30004,beast_reduce_out;feed.theairtraffic.com,30004,beast_reduce_out" -adsblol-env set ADSBLOL_ADDITIONAL_MLAT_CONFIG "feed.adsbexchange.com,31090,39001,--privacy;feed.theairtraffic.com,31090,39002,--privacy" -adsblol-env set MLATHUB_NET_CONNECTOR "adsblol,39000,beast_in;adsblol,39001,beast_in;adsblol,39002,beast_in" -``` -**If you would like to disable privacy mode, instead, use:** -``` -adsblol-env set ADSBLOL_ADDITIONAL_NET_CONNECTOR "feed.adsbexchange.com,30004,beast_reduce_out;feed.theairtraffic.com,30004,beast_reduce_out" -adsblol-env set ADSBLOL_ADDITIONAL_MLAT_CONFIG "feed.adsbexchange.com,31090,39001;feed.theairtraffic.com,31090,39002" -adsblol-env set MLATHUB_NET_CONNECTOR "adsblol,39000,beast_in;adsblol,39001,beast_in;adsblol,39002,beast_in" -```