Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Thom-x committed Mar 7, 2020
1 parent 0bd15e0 commit c49baf2
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 34 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ Run :
```
docker run -d -p 8080:8080 -p 8754:8754 \
--device=/dev/bus/usb:/dev/bus/usb \
-e HTML_SITE_LAT=45.0 \
-e HTML_SITE_LON=9.0 \
-e HTML_SITE_NAME="My Radar Site" \
-e FR24FEED_FR24KEY=MY_SHARING_KEY \
-e PIAWARE_FEEDER_DASH_ID=MY_FEEDER_ID \
-e PANORAMA_ID=FRUXK2G7 \
-e "FR24FEED_FR24KEY=MY_SHARING_KEY" \
-e "PIAWARE_FEEDER_DASH_ID=MY_FEEDER_ID" \
-e "HTML_SITE_LAT=MY_SITE_LAT" \
-e "HTML_SITE_LON=MY_SITE_LON" \
-e "HTML_SITE_NAME=MY_SITE_NAME" \
-e "PANORAMA_ID=MY_PANORAMA_ID" \
thomx/fr24feed-piaware
```

Go to http:https://dockerhost:8080 to view a map of reveived data.
Go to http:https://dockerhost:8754 to view fr24feed configuration panel.

*Note : remove `-v /path/to/your/upintheair.json:/usr/lib/fr24/public_html/upintheair.json` from the command line if you don't want to use this feature.*
*Note : remove `-e "PANORAMA_ID=MY_PANORAMA_ID"` from the command line if you don't want to use this feature.*

# Configuration

Expand All @@ -53,7 +53,7 @@ To disable starting a service you can add an environement variable :
| `SERVICE_ENABLE_FR24FEED` | `false` | Disable fr24feed service |
| `SERVICE_ENABLE_HTTP` | `false` | Disable http service |

Ex : `-e SERVICE_ENABLE_HTTP=false`
Ex : `-e "SERVICE_ENABLE_HTTP=false"`


## FlightAware
Expand All @@ -70,7 +70,7 @@ Add the environment variable `PIAWARE_FEEDER_DASH_ID` with your feeder id.

And claim it on https://fr.flightaware.com/adsb/piaware/claim.

Ex : `-e PIAWARE_RECEIVER_DASH_TYPE=other`
Ex : `-e "PIAWARE_RECEIVER_DASH_TYPE=other"`

## FlightRadar24
Register to https://www.flightradar24.com/share-your-data and get a sharing key.
Expand All @@ -90,7 +90,7 @@ Add the environment variable `FR24FEED_FR24KEY` with your sharing key.
| `FR24FEED_MLAT` | `mlat` | `no` |
| `FR24FEED_MLAT_DASH_WITHOUT_DASH_GPS` | `mlat-without-gps` | `no` |

Ex : `-e FR24FEED_LOGMODE=0`
Ex : `-e "FR24FEED_LOGMODE=0"`

## Add custom properties

Expand All @@ -113,7 +113,7 @@ Example :
| `HTML_SITE_LON` | `9.0` |
| `HTML_SITE_NAME` | `My Radar Site` |

Ex : `-e HTML_SITE_NAME="My site"`
Ex : `-e "HTML_SITE_NAME=My site"`

### Terrain-limit rings (optional):
If you don't need this feature ignore this.
Expand All @@ -127,7 +127,7 @@ Create a panorama for your receiver location on http:https://www.heywhatsthat.com.

*Note : the panorama id value correspond to the URL at the top of the panorama http:https://www.heywhatsthat.com/?view=XXXX, altitudes are in meters, you can specify a list of altitudes.*

Ex : `-e PANORAMA_ID=FRUXK2G7`
Ex : `-e "PANORAMA_ID=FRUXK2G7"`

If you don't want to download the limit every time you bring up the container you can download `http:https://www.heywhatsthat.com/api/upintheair.json?id=${PANORAMA_ID}&refraction=0.25&alts=${PANORAMA_ALTS}` as upintheair.json and mount it in `/usr/lib/fr24/public_html/upintheair.json`.

Expand Down
26 changes: 8 additions & 18 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,15 @@
version: "3.7"
services:
fr24feed-piaware:
build: .
image: "thomx/fr24feed-piaware"
restart: unless-stopped
# expose
# 30001 - Raw output listen port
# 30002 - Feed Dump1090 input listen port
# 30003 - TCP BaseStation output listen port
# 30004 - TCP Beast input listen port
# 30005 - TCP Beast output listen port
# 8754 - DUMP1090 server port
# 8080 - HTTP server port
expose:
- "30001"
- "30002"
- "30003"
- "30004"
- "30005"
- "30104"
- "8754"
- "8080"
environment:
- "FR24FEED_FR24KEY=MY_SHARING_KEY"
- "PIAWARE_FEEDER_DASH_ID=MY_FEEDER_ID"
- "HTML_SITE_LAT=MY_SITE_LAT"
- "HTML_SITE_LON=MY_SITE_LON"
- "HTML_SITE_NAME=MY_SITE_NAME"
- "PANORAMA_ID=MY_PANORAMA_ID"
devices:
- "/dev/bus/usb"
# ports
Expand Down
2 changes: 1 addition & 1 deletion root/etc/cont-init.d/01-confd-fr24feed
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default_value()
key=${1//\-/_DASH_}
key=FR24FEED_${key^^}
eval "value=\${$key:-\$2}"
printf -v $key "$value"
printf -v $key -- "$value"
export $key
}

Expand Down
2 changes: 1 addition & 1 deletion root/etc/cont-init.d/02-confd-piaware
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default_value()
key=${1//\-/_DASH_}
key=PIAWARE_${key^^}
eval "value=\${$key:-\$2}"
printf -v $key "$value"
printf -v $key -- "$value"
export $key
}

Expand Down
2 changes: 1 addition & 1 deletion root/etc/cont-init.d/03-confd-html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default_value()
key=${1//\-/_DASH_}
key=HTML_${key^^}
eval "value=\${$key:-\$2}"
printf -v $key "$value"
printf -v $key -- "$value"
export $key
}

Expand Down
2 changes: 1 addition & 1 deletion root/etc/cont-init.d/04-upintheair
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default_value()
key=${1//\-/_DASH_}
key=PANORAMA_${key^^}
eval "value=\${$key:-\$2}"
printf -v $key "$value"
printf -v $key -- "$value"
export $key
}

Expand Down

0 comments on commit c49baf2

Please sign in to comment.