From c2e34f7c36f213428924ea8a68dd274d6fbb1625 Mon Sep 17 00:00:00 2001
From: Jimmy Zelinskie <jimmy.zelinskie+git@gmail.com>
Date: Mon, 23 Jan 2017 14:03:32 -0500
Subject: [PATCH] example_config: quote all strings and fix docs

---
 example_config.yaml | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/example_config.yaml b/example_config.yaml
index 03c52dc..8d28b61 100644
--- a/example_config.yaml
+++ b/example_config.yaml
@@ -6,7 +6,7 @@ chihaya:
   # The network interface that will bind to an HTTP endpoint that can be
   # scraped by an instance of the Prometheus time series database.
   # For more info see: https://prometheus.io
-  prometheus_addr: 0.0.0.0:6880
+  prometheus_addr: "0.0.0.0:6880"
 
   # The maximum number of peers returned in an announce.
   max_numwant: 50
@@ -19,15 +19,15 @@ chihaya:
   http:
     # The network interface that will bind to an HTTP server for serving
     # BitTorrent traffic.
-    addr: 0.0.0.0:6881
+    addr: "0.0.0.0:6881"
 
-    # When enabled, the IP address used to connect to the tracker overrides
-    # the value clients advertise.
+    # When enabled, the IP address used to connect to the tracker will not
+    # override the value clients advertise as their IP address.
     allow_ip_spoofing: false
 
     # The HTTP Header containing the IP address of the client.
     # This is only necessary if using a reverse proxy.
-    real_ip_header: x-real-ip
+    real_ip_header: "x-real-ip"
 
     # The timeout durations for HTTP requests.
     read_timeout: 5s
@@ -39,18 +39,17 @@ chihaya:
   udp:
     # The network interface that will bind to a UDP server for serving
     # BitTorrent traffic.
-    addr: 0.0.0.0:6881
+    addr: "0.0.0.0:6881"
 
-    # When enabled, the IP address used to connect to the tracker overrides
-    # the value clients advertise.
+    # When enabled, the IP address used to connect to the tracker will not
+    # override the value clients advertise as their IP address.
     allow_ip_spoofing: false
 
     # The leeway for a timestamp on a connection ID.
     max_clock_skew: 10s
 
     # The key used to encrypt connection IDs.
-    private_key: |
-      paste a random string here that will be used to hmac connection IDs
+    private_key: "paste a random string here that will be used to hmac connection IDs"
 
   # This block defines configuration used for the storage of peer data.
   storage:
@@ -70,17 +69,17 @@ chihaya:
   prehooks:
   - name: jwt
     config:
-      issuer: https://issuer.com
-      audience: https://chihaya.issuer.com
-      jwk_set_url: https://issuer.com/keys
+      issuer: "https://issuer.com"
+      audience: "https://chihaya.issuer.com"
+      jwk_set_url: "https://issuer.com/keys"
       jwk_set_update_interval: 5m
 
   - name: client approval
     config:
       whitelist:
-      - OP1011
+      - "OP1011"
       blacklist:
-      - OP1012
+      - "OP1012"
 
   - name: interval variation
     config: