Update README.md

This commit is contained in:
ian
2026-01-23 17:10:24 +00:00
parent edb8dd5e0e
commit 33de618808

View File

@@ -83,6 +83,8 @@ cp config-example.yml config.yml
Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve enabling or disabling the various providers of spot and alert data. Then edit `config.yml` in your text editor of choice to set up the software as you like it. Mostly, this will involve enabling or disabling the various providers of spot and alert data.
By default, all outdoor programme providers are enabled, as is one cluster node and the NG3K DXpedition data. The RBN spot providers are turned off by default due to the volume of traffic from CW/RTTY/FT8 skimmers, and the APRS and Packet spot providers are off by default on the assumption that Spothole users want a spot with a human at the other end of it, but all can be easily re-enabled.
`config.yml` has some entries for QRZ.com username & password, and Clublog API keys. If provided, these allow Spothole to retrieve more information about DX spots, such as the country their callsign corresponds to. The software will work just fine without them, but you may find a few country flags etc. are less accurate or missing. `config.yml` has some entries for QRZ.com username & password, and Clublog API keys. If provided, these allow Spothole to retrieve more information about DX spots, such as the country their callsign corresponds to. The software will work just fine without them, but you may find a few country flags etc. are less accurate or missing.
Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your server too. Clublog API keys are free, but you'll need to get your own by submitting a helpdesk ticket and explaining what you'll use it for. The admin team are happy with the rate of requests made by my Spothole server, so unless you change the source code of yours to radically increase the rate of querying Clublog, I'm sure they will be fine with your server too.
@@ -102,6 +104,102 @@ The software can take a few seconds to start up, mostly because it is downloadin
If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server that is already in use by something else. If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server that is already in use by something else.
### Multiple cluster nodes with different settings
Dan, S50U has written in with his Spothole cluster settings. He is using a cluster node which provides RBN spots, and uses different SSIDs on his callsign to get different settings when logged into the same cluster node. For example:
```
-
class: "DXCluster"
name: "S50CLX"
enabled: true
host: "s50clx.si"
port: 41112
login_prompt: "login: "
login_callsign: "callsign-10"
```
Telnet to DXSpider and log in with "callsign-10" and execute the following commands:
CLEAR/SPOTS ALL (delete all previous filters)
UNSET/ANN (stop announce messages)
UNSET/WCY (stop wcy messages)
UNSET/WWV (stop wwv messages)
SET/DX (enable human DX spots)
```
-
class: "DXCluster"
name: "RBN CW"
enabled: true
host: "s50clx.si"
port: 41112
login_prompt: "login: "
login_callsign: "callsign-11"
allow_rbn_spots: true
enabled-by-default-in-web-ui: false
```
Telnet to DXSpider and log in with "callsign-11" and execute the following commands:
CLEAR/SPOTS ALL (delete all previous filters)
UNSET/ANN (stop announce messages)
UNSET/WCY (stop wcy messages)
UNSET/WWV (stop wwv messages)
UNSET/DX (stop human DX spots)
SET/SKIMMER CW (enable CW RBN spots)
```
-
class: "DXCluster"
name: "RBN RTTY"
enabled: true
host: "s50clx.si"
port: 41112
login_prompt: "login: "
login_callsign: "callsign-12"
allow_rbn_spots: true
enabled-by-default-in-web-ui: false
```
Telnet to DXSpider and log in with "callsign-12" and execute the following commands:
CLEAR/SPOTS ALL (delete all previous filters)
UNSET/ANN (stop announce messages)
UNSET/WCY (stop wcy messages)
UNSET/WWV (stop wwv messages)
UNSET/DX (stop human DX spots)
SET/SKIMMER RTTY (enable RTTY RBN spots)
```
-
class: "DXCluster"
name: "RBN FT4/8"
enabled: true
host: "s50clx.si"
port: 41112
login_prompt: "login: "
login_callsign: "callsign-13"
allow_rbn_spots: true
enabled-by-default-in-web-ui: false
```
Telnet to DXSpider and log in with "callsign-13" and execute the following commands:
CLEAR/SPOTS ALL (delete all previous filters)
UNSET/ANN (stop announce messages)
UNSET/WCY (stop wcy messages)
UNSET/WWV (stop wwv messages)
UNSET/DX (stop human DX spots)
SET/SKIMMER FT (enable FT RBN spots)
For each callsign-SSID, we also specify our basic information with commands:
SET/NAME Spothole10, Spothole11... etc
SET/QTH Cerkno
SET/QRA JN66XD
SET/HOME S50CLX
### systemd configuration ### systemd configuration
If you want Spothole to run automatically on startup on a Linux distribution that uses `systemd`, follow the instructions here. For distros that don't use `systemd`, or Windows/OSX/etc., you can find generic instructions for your OS online. If you want Spothole to run automatically on startup on a Linux distribution that uses `systemd`, follow the instructions here. For distros that don't use `systemd`, or Windows/OSX/etc., you can find generic instructions for your OS online.