Replace dash-separated config & API properties with underscore-separated versions. #127

config-example.yml

@@ -4,18 +4,18 @@
 # Your callsign. Used to log into DX clusters and included in User-Agent when querying HTTP servers. Useful so if your
 # server goes crazy and causes other people problems, they know who to contact :) If you don't have one, you can leave
 # this as "N0CALL" and it shouldn't do any harm, as we're not sending anything to the various networks, only receiving.
-server-owner-callsign: "N0CALL"
+server_owner_callsign: "N0CALL"
 
 # Port to open the local web server on
-web-server-port: 8080
+web_server_port: 8080
 
 # Run in API-only mode? When enabled, the web UI is not served, only the API endpoints and the OpenAPI documentation
 # page. If you are running your own Spothole instance purely to serve client software, and not wanting visitors to
 # discover a full web-based cluster UI, enable this flag.
-api-only-mode: false
+api_only_mode: false
 
 # The base URL at which the software runs.
-base-url: "http://localhost:8080"
+base_url: "http://localhost:8080"
 
 # Spot providers to use. This is an example set, tailor it to your liking by commenting and uncommenting.
 # RBN and APRS-IS are supported but have such a high data rate, you probably don't want them enabled.
@@ -23,7 +23,7 @@ base-url: "http://localhost:8080"
 # addresses and ports. You can duplicate them if you like, e.g. to support several DX clusters. RBN uses two ports, 7000
 # for CW/RTTY and 7001 for FT8, so if you want both, you need two entries, as shown below.
 # Feel free to write your own provider classes! There are details in the README.
-spot-providers:
+spot_providers:
   - class: "POTA"
     enabled: true
 
@@ -39,7 +39,7 @@ spot-providers:
   - class: "GMA"
     enabled: true
     # GMA requires an API key to fetch spots. After creating an account on cqgma.org, email support and request one.
-    api-key: ""
+    api_key: ""
 
   - class: "HEMA"
     enabled: true
@@ -100,18 +100,18 @@ spot-providers:
     # This setting doesn't affect the spot provider itself, or anything in the back-end of Spothole, just the web UI.
     # By default spots from all enabled providers will be shown in the web UI. However, you might want RBN data to be
     # received by Spothole but not shown on the web UI unless the user explicitly turns it on. For that behaviour,
-    # set enabled to true, but enabled-by-default-in-web-ui to false.
-    enabled-by-default-in-web-ui: false
+    # set enabled to true, but enabled_by_default_in_web_ui to false.
+    enabled_by_default_in_web_ui: false
 
   - class: "RBN"
     name: "RBN FT8"
     enabled: false
     port: 7001
-    enabled-by-default-in-web-ui: false
+    enabled_by_default_in_web_ui: false
 
   - class: "UKPacketNet"
     enabled: false
-    enabled-by-default-in-web-ui: false
+    enabled_by_default_in_web_ui: false
 
   - class: "XOTA"
     # xOTA sources have a "name" property so you can define what programme it is for, since xOTA is generic software
@@ -125,25 +125,25 @@ spot-providers:
     # For Toilets on the Air, we prefix the SIG references (T-01 etc) with some characters that define the conference:
     # C3, EH or HOPE - so we can look up the correct locations in our database, because each conference starts from T-01
     # but refers to a toilet in a different building (or continent!)
-    sig-ref-prefix: "C3"
+    sig_ref_prefix: "C3"
 
   - class: "XOTA"
     name: "EH23 TOTA"
     enabled: false
     url: "wss://eh23.totawatch.de/api/spot/live"
     sig: "Toilets"
-    sig-ref-prefix: "EH"
+    sig_ref_prefix: "EH"
 
   - class: "XOTA"
     name: "HOPE26 TOTA"
     enabled: false
     url: "wss://hope-26.totawatch.de/api/spot/live"
     sig: "Toilets"
-    sig-ref-prefix: "HOPE"
+    sig_ref_prefix: "HOPE"
 
 
 # Alert providers to use. Same setup as the spot providers list above.
-alert-providers:
+alert_providers:
   - class: "POTA"
     enabled: true
 
@@ -168,7 +168,7 @@ alert-providers:
 
 # Solar condition providers to use. These poll external APIs for solar propagation data (SFI, A/K indices, band
 # conditions, etc.) and make it available via the /api/v2/solar endpoint.
-solar-condition-providers:
+solar_condition_providers:
   - class: "HamQSL"
     enabled: true
 
@@ -184,7 +184,7 @@ solar-condition-providers:
 
 # Static reference data providers to use. These allow Spothole to download data such as mapping between callsign
 # prefixes and DXCC entities.
-static-data-providers:
+static_data_providers:
   - class: "K0SWE"
     enabled: true
 
@@ -197,7 +197,7 @@ static-data-providers:
 
 # SIG reference data providers to use. These allow Spothole to download, for example, the WWFF directory that maps WWFF
 # park IDs to their name and location.
-sig-ref-data-providers:
+sig_ref_data_providers:
   - class: "POTA"
     enabled: true
 
@@ -260,7 +260,7 @@ sig-ref-data-providers:
 # 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:
+callsign_data_providers:
   - class: "QRZ"
     enabled: true
     # Callsign data providers can often provide conflicting data, e.g. a home location from QRZ vs the centre of the
@@ -283,14 +283,14 @@ callsign-data-providers:
     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: ""
+    api_key: ""
 
   - class: "ClublogXML"
     enabled: true
     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: ""
+    api_key: ""
 
   - class: "CountryFiles"
     priority: 5
@@ -299,50 +299,50 @@ callsign-data-providers:
 
 # Maximum time to keep spots and alerts in the system before deleting them. By default, one hour for spots and one week
 # for alerts.
-max-spot-age-sec: 3600
-max-alert-age-sec: 604800
+max_spot_age_sec: 3600
+max_alert_age_sec: 604800
 
 # Allow submitting spots to the Spothole API?
-allow-spotting: true
+allow_spotting: true
 
 # Allow upstream submission of spots to external providers (POTA, SOTA, etc.) via the API?
-# Requires allow-spotting to also be true. Set to false to only accept spots into the local
+# Requires allow_spotting to also be true. Set to false to only accept spots into the local
 # Spothole database, without forwarding them to any external service.
-allow-upstream-spotting: true
+allow_upstream_spotting: true
 
 # Google reCAPTCHA v2 keys for CAPTCHA protection on upstream spot submission. Both keys must be set to enable CAPTCHA.
-# Leave both empty to disable CAPTCHA (e.g. for a private/trusted server) or if allow-spotting is false, in which case
+# Leave both empty to disable CAPTCHA (e.g. for a private/trusted server) or if allow_spotting is false, in which case
 # they will do nothing. Note that with CAPTCHA enabled, this will prevent third-party clients submitting spots through
 # Spothole unless the clients are web-based, use the same site key, have their domains enabled in your reCAPTCHA config,
 # and of course their user solves the CAPTCHA.
 # You can sign up for reCAPTCHA at https://www.google.com/recaptcha/
-recaptcha-site-key: ""
-recaptcha-secret-key: ""
+recaptcha_site_key: ""
+recaptcha_secret_key: ""
 
 # Log web requests? Useful to see what your users are requesting in terms of pages and API endpoints, but will fill up
 # your log quickly on a popular server.
-log-web-requests: false
+log_web_requests: false
 
 # Minimum severity of log statements to print to the system log. Defaults to INFO, change to DEBUG if you need more
 # information.
-log-level: INFO
+log_level: INFO
 
 # Options for the web UI.
-web-ui-options:
-  spot-count: [ 10, 25, 50, 100 ]
-  spot-count-default: 50
-  max-spot-age: [ 5, 10, 30, 60 ]
-  max-spot-age-default: 30
-  alert-count: [ 25, 50, 100, 200, 500 ]
-  alert-count-default: 100
+web_ui_options:
+  spot_count: [ 10, 25, 50, 100 ]
+  spot_count_default: 50
+  max_spot_age: [ 5, 10, 30, 60 ]
+  max_spot_age_default: 30
+  alert_count: [ 25, 50, 100, 200, 500 ]
+  alert_count_default: 100
   # Default UI colour scheme. Supported values are "light", "dark" and "auto" (i.e. use the browser/OS colour scheme).
   # Users can still override this in the UI to their own preference.
-  color-scheme-default: "auto"
+  color_scheme_default: "auto"
   # Default band colour scheme. Supported values are the full names of any band colour scheme shown in the UI.
   # Users can still override this in the UI to their own preference.
-  band-color-scheme-default: "PSK Reporter (Adjusted)"
+  band_color_scheme_default: "PSK Reporter (Adjusted)"
   # Custom HTML insert. This can be any arbitrary HTML. It will be inserted next to the start/stop buttons on the spots
   # (home) page, although being arbitrary HTML you can also use a div with absolute, relative, float placement etc. This
   # is designed for a "donate/support the server" type button, though you are free to do whatever you want with it.
   # As the server owner you are responsible for the safe usage of this option!
-  support-button-html: ""
+  support_button_html: ""