Skip to content

Commit

Permalink
updates to README
Browse files Browse the repository at this point in the history
  • Loading branch information
kx1t committed Oct 23, 2023
1 parent 3275696 commit ee5acb6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
1 change: 1 addition & 0 deletions .hadolint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ignored: [ DL3003, DL3008 ]
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ The following information was copied from the [Radar1090 UK website](https://www
> We need to give your receiver a "station name". Station names string of 3-9 characters in length which can be a placename, callsign, nickname, etc.
>
> We have receivers called things like:
>
>
> FERNHILL (place)
> PENBREY (place)
> BIRTIES (nickname)
> In many cases an approximate location works well as it reminds us where the receiver is located but provides a degree of privacy.
>
>
> **Antenna location**
> We need the Latitude/Longitude of your antenna...
>
Expand Down Expand Up @@ -79,13 +79,12 @@ Once you have added this to your setup, simply do `docker compose up -d` in the

## Watchdog

The container uses an internal Watchdog to ensure that data is still flowing to the Radar1090 Server. Data flow can stop for any reason, and often the container can self-repair to get the data flow starting again.
The watchdog runs by default every 15 minutes, and when it runs, it samples the data stream for 15 seconds. If no data flow was detected going from the container to the Radar1090 Server, it will try to restart the internal feeder module in an attempt to get data flowing again.
The container uses an internal Watchdog to ensure that data is still flowing to the Radar1090 Server. Data flow can stop for any reason, and often the container can self-repair to get the data flow starting again.
The watchdog runs by default every 15 minutes, and when it runs, it samples the data stream for 15 seconds. If no data flow was detected going from the container to the Radar1090 Server, it will try to restart the internal feeder module in an attempt to get data flowing again.

Additionally, it will increase the *failure counter* (or reset this counter if data is flowing again).
Once the *failure counter* is greater or equal to 3, the container's HEALTHCHECK will go *UNHEALTHY*. This will enable external management containers like `autoheal` to automatically restart the entire container.


## Supported parameters

The following parameters are supported for the `docker-radar1090` container. Please note that only the `RADAR1090_KEY` parameter is mandatory, the rest are optional.
Expand Down

0 comments on commit ee5acb6

Please sign in to comment.