example_config: quote all strings and fix docs

This commit is contained in:
Jimmy Zelinskie 2017-01-23 14:03:32 -05:00
parent 91a0b4012a
commit c2e34f7c36

View file

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