Update docs and examples to include "agencycountrycode"

salcock · Aug 12, 2024 · db8f36c · db8f36c
1 parent 0414e6e
commit db8f36c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/doc/ProvisionerDoc.md b/doc/ProvisionerDoc.md
@@ -439,6 +439,8 @@ Agencies are expressed as a YAML sequence with a key of `agencies:`. Each
 sequence item represents a single agency and must contain the following
 key-value elements:
 * `agencyid`      -- the unique internal identifier for this agency
+* `agencycountrycode`  -- the 2-letter ISO 3166 country code for the country
+                          where the agency is located.
 * `hi2address`    -- the address of the HI2 handover on the agency side
 * `hi2port`       -- the port number for the HI2 handover on the agency side
 * `hi3address`    -- the address of the HI3 handover on the agency side

diff --git a/doc/exampleconfigs/running-intercept-example.yaml b/doc/exampleconfigs/running-intercept-example.yaml
@@ -61,6 +61,8 @@ defaultradiususers:
 agencies:
 
  - agencyid: "Police"           # id must be unique per agency
+   agencycountrycode: "NZ"      # 2 letter country code (ISO 3166) matching the
+                                # agency's jurisdiction
    hi2address: 192.168.200.1    # address of the HI2 service at the agency
    hi2port: 35530               # port number of the HI2 service at the agency
    hi3address: 192.168.200.1    # address of the HI3 service at the agency
@@ -71,6 +73,8 @@ agencies:
                                 # 30 seconds to avoid being disconnected
 
  - agencyid: "Spooks"           # id must be unique per agency
+   agencycountrycode: "NZ"      # 2 letter country code (ISO 3166) matching the
+                                # agency's jurisdiction
    hi2address: 10.10.1.1        # address of the HI2 service at the agency
    hi2port: 7001                # port number of the HI2 service at the agency
    hi3address: 10.10.1.2        # address of the HI3 service at the agency