Skip to content

Commit f990c61

Browse files
authored
Fixing code blocks (#163)
Fixes the blacklist where the install should be a part of the ppm testing. Adjusts code block language markup. Changes most variables that can be replaced by that of .env.
1 parent 95f24d1 commit f990c61

21 files changed

+130
-94
lines changed

feeder-containers/feeding-adsbhub.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ In your station preferences, you should set the following:
2828

2929
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
3030

31-
```text
31+
```shell
3232
nano /opt/adsb/.env
3333
```
3434

3535
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our ADSBHub Station Key to this file. Add the following line to the file:
3636

37-
```text
37+
```shell
3838
ADSBHUB_STATION_KEY='YOURSTATIONKEY'
3939
```
4040

@@ -43,7 +43,7 @@ ADSBHUB_STATION_KEY='YOURSTATIONKEY'
4343

4444
For example:
4545

46-
```text
46+
```shell
4747
ADSBHUB_STATION_KEY='vrMr@AZn660X0H^0Usn~rcj$UJA7VlR.vEu4c;uh7mfU-J9ZUBXpJiUuWj37DTa5BtL'
4848
```
4949

feeder-containers/feeding-airnavradar.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ You'll need a _sharing key_. To get one, you can temporarily run the container,
2727

2828
Inside your application directory \(`/opt/adsb`\), run the following commands:
2929

30-
```bash
31-
docker pull ghcr.io/sdr-enthusiasts/docker-airnavradar:latest
30+
```shell
3231
source ./.env
3332
timeout 60 docker run \
3433
--rm \
@@ -38,7 +37,7 @@ timeout 60 docker run \
3837
-e LAT=${FEEDER_LAT} \
3938
-e LONG=${FEEDER_LONG} \
4039
-e ALT=${FEEDER_ALT_M} \
41-
ghcr.io/sdr-enthusiasts/docker-airnavradar
40+
ghcr.io/sdr-enthusiasts/docker-airnavradar:latest
4241
```
4342

4443
The command will run the container for one minute, which should be ample time for the container to connect to Airnav Radar receive a sharing key.
@@ -95,13 +94,13 @@ As you can see from the output above, the sharing key given to us from Airnav Ra
9594

9695
If the script doesn't output the sharing key, it can be found by using the following command:
9796

98-
```bash
97+
```shell
9998
docker exec -it rbfeeder /bin/sh -c "cat /etc/rbfeeder.ini" | grep key
10099
```
101100

102101
Command output:
103102

104-
```text
103+
```shell
105104
key=g45643ab345af3c5d5g923a99ffc0de9
106105
```
107106

@@ -115,21 +114,21 @@ key=g45643ab345af3c5d5g923a99ffc0de9
115114

116115
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
117116

118-
```bash
117+
```shell
119118
nano /opt/adsb/.env
120119
```
121120

122121
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our `rbfeeder` sharing key to this file. Add the following line to the file:
123122

124-
```bash
123+
```shell
125124
AIRNAVRADAR_SHARING_KEY=YOURSHARINGKEY
126125
```
127126

128127
* Replace `YOURSHARINGKEY` with the sharing key that was generated in the previous step.
129128

130129
For example:
131130

132-
```bash
131+
```shell
133132
AIRNAVRADAR_SHARING_KEY=g45643ab345af3c5d5g923a99ffc0de9
134133
```
135134

feeder-containers/feeding-flightaware-piaware.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You'll need your _feeder-id_ from your existing feeder.
2020

2121
To get your _feeder-id_, log onto your feeder via SSH and issue the command:
2222

23-
```bash
23+
```shell
2424
piaware-config -show feeder-id
2525
```
2626

@@ -32,7 +32,7 @@ You'll need a _feeder-id_. To get one, you can temporarily run the container, to
3232

3333
Inside your application directory \(`/opt/adsb`\), run the following commands:
3434

35-
```text
35+
```shell
3636
docker pull ghcr.io/sdr-enthusiasts/docker-piaware:latest
3737
source ./.env
3838
timeout 60 docker run --rm -e LAT="$FEEDER_LAT" -e LONG="$FEEDER_LONG" ghcr.io/sdr-enthusiasts/docker-piaware:latest | grep "my feeder ID"
@@ -42,7 +42,7 @@ The command will run the container for 60 seconds, which should be ample time fo
4242

4343
For example:
4444

45-
```text
45+
```ShellSession
4646
$ timeout 60 docker run --rm LAT="$FEEDER_LAT" -e LONG="$FEEDER_LONG" ghcr.io/sdr-enthusiasts/docker-piaware:latest | grep "my feeder ID"
4747
Set allow-mlat to yes in /etc/piaware.conf:1
4848
Set allow-modeac to yes in /etc/piaware.conf:2
@@ -65,21 +65,21 @@ Note - for PiAware/FlightAware feeding to work correctly, you MUST accurately se
6565

6666
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
6767

68-
```bash
68+
```shell
6969
nano /opt/adsb/.env
7070
```
7171

7272
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our `piaware` feeder-id to this file. Add the following line to the file:
7373

74-
```text
74+
```shell
7575
PIAWARE_FEEDER_ID=YOURFEEDERID
7676
```
7777

7878
* Replace `YOURFEEDERID` with the feeder-id that was generated in the previous step.
7979

8080
For example:
8181

82-
```text
82+
```shell
8383
PIAWARE_FEEDER_ID=acbf1f88-09a4-3a47-a4a0-10ae138d0c1g
8484
```
8585

feeder-containers/feeding-flightradar24.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You'll need your _fr24key_ from your existing feeder.
1818

1919
To get your _fr24key_, log onto your feeder and issue the command:
2020

21-
```bash
21+
```shell
2222
cat /etc/fr24feed.ini | grep fr24key
2323
```
2424

@@ -36,7 +36,7 @@ Use the same email address as for your fr24 account if you already have one or p
3636

3737
Run the command:
3838

39-
```text
39+
```shell
4040
docker run -it --rm ghcr.io/sdr-enthusiasts/docker-baseimage:qemu bash -c "$(curl -sSL https://raw.githubusercontent.com/sdr-enthusiasts/docker-flightradar24/main/get_adsb_key.sh)"
4141
```
4242

@@ -64,15 +64,15 @@ Congratulations! You are now registered and ready to share ADS-B data with Fligh
6464

6565
Copy the sharing key you are given, and add the following line to your `.env` file:
6666

67-
```text
67+
```shell
6868
FR24_SHARING_KEY=YOURSHARINGKEY
6969
```
7070

7171
- Replace `YOURSHARINGKEY` with the sharing key from the output of the manual sign-up process.
7272

7373
For example:
7474

75-
```text
75+
```shell
7676
FR24_SHARING_KEY=10ae138d0c1g
7777
```
7878

@@ -82,7 +82,7 @@ Get a separate sharing key for UAT as described [here](https://github.com/sdr-en
8282

8383
Copy the UAT sharing key you are given, and add the following line to your `.env` file:
8484

85-
```text
85+
```shell
8686
FR24_SHARING_KEY_UAT=YOURSHARINGKEYUAT
8787
```
8888

feeder-containers/feeding-new-aggregators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Append the following lines to the end of the file \(inside the `services:` secti
5252
5353
If you already have a `UUID` that was generated for the ADSBExchange service, feel free to reuse that one. If you don't have one, you can generate one by logging onto you Linux machine (Raspberry Pi, etc.) and giving this command:
5454

55-
```bash
55+
```shell
5656
cat /proc/sys/kernel/random/uuid
5757
```
5858

feeder-containers/feeding-opensky-network.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,41 @@ Firstly, make sure you have registered for an account on the [OpenSky Network we
1616

1717
In order to obtain a feeder serial number, we will start a temporary container running `opensky-feeder`, which will connect to OpenSky Network and be issued a serial number. The temporary container will automatically be stopped and deleted after 60 seconds.
1818

19+
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
20+
21+
```shell
22+
nano /opt/adsb/.env
23+
```
24+
25+
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our OpenSky username to this file. Add the following line to the file:
26+
27+
```shell
28+
OPENSKY_USERNAME='YOUROPENSKYUSERNAME'
29+
```
30+
31+
* Replace `YOUROPENSKYUSERNAME` with the station key you retrieved earlier.
32+
33+
For example:
34+
35+
```shell
36+
OPENSKY_USERNAME=johnnytightlips
37+
```
38+
1939
To do this, run the command:
2040

21-
```text
41+
```shell
42+
source ./.env
2243
timeout 60s docker run \
2344
--rm \
2445
-it \
25-
-e LAT=YOURLATITUDE \
26-
-e LONG=YOURLONGITUDE \
27-
-e ALT=YOURALTITUDE \
46+
-e LAT=${FEEDER_LAT} \
47+
-e LONG=${FEEDER_LONG} \
48+
-e ALT=${FEEDER_ALT_M} \
2849
-e BEASTHOST=ultrafeeder\
29-
-e OPENSKY_USERNAME=YOUROPENSKYUSERNAME \
30-
ghcr.io/sdr-enthusiasts/docker-opensky-network
50+
-e OPENSKY_USERNAME=${OPENSKY_USERNAME} \
51+
ghcr.io/sdr-enthusiasts/docker-opensky-network:latest
3152
```
3253

33-
Be sure to change the following:
34-
35-
* Replace `YOURLATITUDE` with the latitude of your antenna \(xx.xxxxx\)
36-
* Replace `YOURLONGITUDE` with the longitude of your antenna \(xx.xxxxx\)
37-
* Replace `YOURALTITUDE` with the altitude above sea level of your antenna _**in metres**_
38-
* Replace `YOUROPENSKYUSERNAME` with your OpenSky Network username
39-
4054
Once the container has started, you should see output similar to the following:
4155

4256
```text
@@ -103,23 +117,23 @@ As you can see from the output above, we've been allocated a serial number of `-
103117

104118
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
105119

106-
```text
120+
```shell
107121
nano /opt/adsb/.env
108122
```
109123

110124
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our OpenSky-Network username and serial to this file. Add the following lines to the file:
111125

112-
```text
126+
```shell
113127
OPENSKY_USERNAME=YOUROPENSKYUSERNAME
114128
OPENSKY_SERIAL=YOUROPENSKYSERIAL
115129
```
116130

117-
* Replace `YOUROPENSKYUSERNAME` with your OpenSky Network username
131+
* Replace `YOUROPENSKYUSERNAME` with your OpenSky Network username. Yo should have already done this in the previous step.
118132
* Replace `YOUROPENSKYSERIAL` with your OpenSky Network serial
119133

120134
For example:
121135

122-
```text
136+
```shell
123137
OPENSKY_USERNAME=johnnytightlips
124138
OPENSKY_SERIAL=-1408234269
125139
```

feeder-containers/feeding-plane-watch.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,21 @@ When you save your feeder, an **API Key** will be generated. Take note of this,
2424

2525
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
2626

27-
```bash
27+
```shell
2828
nano /opt/adsb/.env
2929
```
3030

3131
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our plane.watch variables to this file. Add the following lines to the file:
3232

33-
```text
33+
```shell
3434
PW_API_KEY=YOURAPIKEY
3535
```
3636

3737
* Replace `YOURAPIKEY` with the API KEY that was provided the previous step.
3838

3939
For example:
4040

41-
```text
41+
```shell
4242
PW_API_KEY=4e8413e6-52eb-11ea-8681-1c1b0d925d3g
4343
```
4444

@@ -127,5 +127,3 @@ After a few minutes, browse to [https://atc.plane.watch/](https://atc.plane.watc
127127
## Advanced
128128

129129
If you want to look at more options and examples for the `plane.watch` container, you can find the repository [here](https://github.com/plane-watch/docker-plane-watch).
130-
131-

feeder-containers/feeding-planefinder.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You'll need a _share code_. In order to obtain a PlaneFinder Share Code, we will
2626

2727
Run the command:
2828

29-
```text
29+
```shell
3030
docker run \
3131
--rm \
3232
-it \
@@ -59,21 +59,21 @@ You should now claim your receiver:
5959

6060
Inside your application directory \(`/opt/adsb`\), edit the `.env` file using your favourite text editor. Beginners may find the editor `nano` easy to use:
6161

62-
```text
62+
```shell
6363
nano /opt/adsb/.env
6464
```
6565

6666
This file holds all of the commonly used variables \(such as our latitude, longitude and altitude\). We're going to add our `pfclient` share code to this file. Add the following line to the file:
6767

68-
```text
68+
```shell
6969
PLANEFINDER_SHARECODE=YOURSHARECODE
7070
```
7171

7272
* Replace `YOURSHARECODE` with the share code that was generated in the previous step.
7373

7474
For example:
7575

76-
```text
76+
```shell
7777
PLANEFINDER_SHARECODE=zg84632abhf231
7878
```
7979

@@ -169,7 +169,7 @@ Once running, you can visit `http://docker.host.ip.addr:30053` to access the `pf
169169

170170
If you are running a Raspberry Pi 5, then you may see the following messages in your Docker Compose log output:
171171

172-
```
172+
```text
173173
pfclient | [pfclient_daemon] /usr/local/bin/pfclient: error while loading shared libraries:
174174
pfclient | [pfclient_daemon] /usr/local/bin/pfclient: error while loading shared libraries:
175175
pfclient | [pfclient_daemon] /usr/local/bin/pfclient: error while loading shared libraries:

0 commit comments

Comments
 (0)