From aecb88ee16b923341e5450cd0f3600639158a8dc Mon Sep 17 00:00:00 2001 From: MNTech68 <48815423+MNTech68@users.noreply.github.com> Date: Wed, 28 Aug 2024 16:00:32 -0500 Subject: [PATCH] Update README.md Updated documentation and added example regarding variable handling by mlat-client when utilizing gpsd functions. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19e5d6d..9def004 100644 --- a/README.md +++ b/README.md @@ -832,7 +832,7 @@ If you have any issues, readsb will use verbose output if you add the `GPSD_DEBU ### Optional parameters regulating the restart of `mlat-client` when the location changes -The following parameters are all optional and are subject to change. You don't need to set them unless you want to change the default behavior: +The following parameters are all optional and are subject to change. These variables should be added to the environment section of your docker-compose.yml. They will not work if entered into the .env file. You don't need to set them unless you want to change the default behavior. | Environment Variable | Purpose | Default | | -------------------- | ------- | ------- | @@ -840,6 +840,17 @@ The following parameters are all optional and are subject to change. You don't n | `GPSD_MLAT_WAIT` | The wait period (in seconds) your station must be stationary before mlat is started (minimum 90 seconds) | `90` (seconds) | | `GPSD_CHECK_INTERVAL` | How often the container checks for updated location information. (minimum 5 seconds) | `30` (seconds) | +See example below: + +```yaml + environment: + ... + - GPSD_MIN_DISTANCE=20 + - GPSD_MLAT_WAIT=90 + - GPSD_CHECK_INTERVAL=30 + ... +``` + ## Web Pages If you have configured the container as described above, you should be able to browse to the following web pages: