From 3e8b07b9e11a0597e06a895d53119083de56ef57 Mon Sep 17 00:00:00 2001 From: kx1t Date: Tue, 9 May 2023 11:56:20 -0400 Subject: [PATCH] doc and other updates --- README.md | 12 +++++++++++- rootfs/etc/services.d/mlathub/run | 8 ++++---- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 07c4cc4..de746e3 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ - [Output from Ultrafeeder to Prometheus](#output-from-ultrafeeder-to-prometheus) - [Output from Ultrafeeder to InfluxDBv2](#output-from-ultrafeeder-to-influxdbv2) - [Message decoding introspection](#message-decoding-introspection) + - [Minimalist setup](#minimalist-setup) - [Logging](#logging) - [Getting help](#getting-help) - [Acknowledgements](#acknowledgements) @@ -664,7 +665,8 @@ Generally, there is little to configure, but there are a few parameters that you | `MLATHUB_BEAST_IN_PORT` | TCP port you where you can send additional MLAT results to, in Beast format | `31004` | | `MLATHUB_BEAST_OUT_PORT` | TCP port where consolidated MLAT results will be available in Beast format | `31005` | | `MLATHUB_BEAST_REDUCE_OUT_PORT` | TCP port where consolidated MLAT results will be available in Beast format with reduced data rates | `31006` | -| `MLATHUB_NET_CONNECTOR` | List of semi-colon (`;`) separated IP or host, port, and protocols where MLATHUB will connect to ingest or send MLAT data. It follows the same syntax as described in the [`READSB_NET_CONNECTOR` syntax section](#alternate-configuration-method-with-readsb_net_connector) above. | Unset | +| `MLATHUB_NET_CONNECTOR` | List of semi-colon (`;`) separated IP or host, port, and protocols where MLATHUB will connect to ingest or send MLAT data. It follows the same syntax as described in the [`READSB_NET_CONNECTOR` syntax section](#alternate-configuration-method-with-readsb_net_connector) above | Unset | +| `MLATHUB_DISABLE` | If set to `true`, the MLATHUB will be disabled even if there are `mlat-client`s running in the container | Unset | ## Display of Metrix with Grafana and Prometheus/InfluxDB @@ -719,6 +721,14 @@ docker exec -it ultrafeeder /usr/local/bin/viewadsb --no-interactive docker exec -it ultrafeeder /usr/local/bin/viewadsb --cpr-focus 3D3ED0 ``` +## Minimalist setup + +If you want to use `ultrafeeder` *only* as a SDR decoder but without any mapping or stats/graph websites, without MLAT connections or MLAT-hub, etc., for example to minimize CPU and RAM needs on a low CPU/memory single board computer, then do the following: + +- in the `ULTRAFEEDER_CONFIG` parameter, remove any entry that starts with `mlat` or `mlathub`. This will prevent any `mlat-client`s or `mlathub` instances to be launched. If you still want to connect the `mlat-client`(s) to external MLAT servers but you don't want to run the overhead of a MLATHUB, you can leave any entries starting with `mlat` in the `ULTRAFEEDER_CONFIG` parameter, and set `MLATHUB_DISABLE=true` +- Set the parameter `TAR1090_DISABLE=true`. This will prevent the `nginx` webserver and any websites to be launched and no `collectd` (graphs1090) or `rrd` (ADSB message history) data to be collected or retained. +- Make sure to use `ghcr.io/sdr-enthusiasts/docker-adsb-ultrafeeder:latest` and specifically NOT the `ghcr.io/sdr-enthusiasts/docker-adsb-ultrafeeder:telegraf` label as Telegraf adds a LOT of resource use to the container + ## Logging All logs are to the container's stdout and can be viewed with `docker logs -t [-f] container`. diff --git a/rootfs/etc/services.d/mlathub/run b/rootfs/etc/services.d/mlathub/run index f967cbb..6dab8ee 100644 --- a/rootfs/etc/services.d/mlathub/run +++ b/rootfs/etc/services.d/mlathub/run @@ -8,12 +8,12 @@ s6wrap=(s6wrap --quiet --timestamps --prepend="${APPNAME}") if [[ -z "${MLAT_CONFIG}" ]] && [[ -z "$MLATHUB_NET_CONNECTOR" ]]; then "${s6wrap[@]}" --args echo "No MLAT servers have been defined in MLAT_CONFIG and no external sources have been defined in MLATHUB_NET_CONNECTOR - no need to start MLATHUB" - sleep infinity + exec sleep infinity fi -if chk_enabled "${MLATHUB_DISABLED}"; then +if chk_enabled "${MLATHUB_DISABLE}"; then "${s6wrap[@]}" --args echo "MLATHUB is disabled." - sleep infinity + exec sleep infinity fi # Build the readsb command line based on options @@ -61,7 +61,7 @@ done if (( mlat_result_sources == 0 )) then "${s6wrap[@]}" --args echo "No MLAT servers have been defined in MLAT_CONFIG - no need to start MLATHUB" - sleep infinity + exec sleep infinity fi # Add any additional net_connectors: