Refactor of caching & data storage part 14 #118

config-example.yml

@@ -251,32 +251,44 @@ sig-ref-data-providers:
 
 
 # Callsign data providers to use. These allow Spothole to provide information about callsigns, either from static
-# lookups or from web-based services such as QRZ.
+# lookups or from web-based services such as QRZ. Note that use of QRZ and HamQTH is *on behalf of the user*, and
+# requires the user to enter their credentials into the website UI or provide them in an API call. Spothole will not
+# look up all calls via QRZ/HamQTH using the server owner's credentials, as this is against their usage policy.
 callsign-data-providers:
-  - class: "CountryFiles"
+  - class: "QRZ"
     enabled: true
+    # Callsign data providers can often provide conflicting data, e.g. a home location from QRZ vs the centre of the
+    # DXCC entity from a country file lookup. The priority flag sets which source "wins" in the event of conflict.
+    # Lower numbers take priority over higher numbers. Generally then, QRZ/HamQTH should have low numbers as they are
+    # likely to have the most accurate data.
+    priority: 1
+    # No server-side credentials for QRZ. Users must provide their own as per QRZ policy.
 
-  - class: "ClublogXML"
+  - class: "HamQTH"
     enabled: true
-    # API key for Clublog to look up information. Required in order to enable this provider. You will need to request
-    # one via their helpdesk portal if you want to use callsign lookups from Clublog.
-    api-key: ""
+    priority: 2
+    # No server-side credentials for HamQTH. Users must provide their own.
 
   - class: "ClublogAPI"
     # Querying the Clublog API directly doesn't provide any more data than the XML version, it just provides slightly
     # more up-to-date information in the rare case that the prefix data changes, at a significant cost of looking up
     # every callsign via an API call. Normally left disabled but it exists as an option.
     enabled: false
-    # API key for Clublog to look up information. Required in order to enable this provider.
+    priority: 3
+    # API key for Clublog to look up information. Required in order to enable this provider. Unlike QRZ and HamQTH,
+    # Clublog uses an API key issued to Spothole, not to the end user.
     api-key: ""
 
-  - class: "QRZ"
+  - class: "ClublogXML"
     enabled: true
-    # No server-side credentials for QRZ. Users must provide their own as per QRZ policy.
+    priority: 4
+    # API key for Clublog to look up information. Required in order to enable this provider. You will need to request
+    # one via their helpdesk portal if you want to use callsign lookups from Clublog.
+    api-key: ""
 
-  - class: "HamQTH"
+  - class: "CountryFiles"
+    priority: 5
     enabled: true
-    # No server-side credentials for HamQTH. Users must provide their own.
 
 
 # Maximum time to keep spots and alerts in the system before deleting them. By default, one hour for spots and one week