better safe defaults for blocky (#170)

This commit is contained in:
Jeff Billimek 2020-03-11 00:33:52 -04:00 committed by GitHub
parent 92a0db15d1
commit 9203d2d558
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 35 deletions

View File

@ -2,7 +2,7 @@ apiVersion: v1
appVersion: "v0.5" appVersion: "v0.5"
description: DNS proxy as ad-blocker for local network description: DNS proxy as ad-blocker for local network
name: blocky name: blocky
version: 2.2.0 version: 2.2.1
keywords: keywords:
- blocky - blocky
- dbs - dbs

View File

@ -26,15 +26,15 @@ config:
# optional: custom IP address for domain name (with all sub-domains) # optional: custom IP address for domain name (with all sub-domains)
# example: query "printer.lan" or "my.printer.lan" will return 192.168.178.3 # example: query "printer.lan" or "my.printer.lan" will return 192.168.178.3
customDNS: # customDNS:
mapping: # mapping:
printer.lan: 192.168.178.3 # printer.lan: 192.168.178.3
# optional: definition, which DNS resolver should be used for queries to the domain (with all sub-domains). # optional: definition, which DNS resolver should be used for queries to the domain (with all sub-domains).
# Example: Query client.fritz.box will ask DNS server 192.168.178.1. This is necessary for local network, to resolve clients by host name # Example: Query client.fritz.box will ask DNS server 192.168.178.1. This is necessary for local network, to resolve clients by host name
conditional: # conditional:
mapping: # mapping:
fritz.box: udp:192.168.178.1 # fritz.box: udp:192.168.178.1
# optional: use black and white lists to block queries (for example ads, trackers, adult pages etc.) # optional: use black and white lists to block queries (for example ads, trackers, adult pages etc.)
blocking: blocking:
@ -50,9 +50,9 @@ config:
special: special:
- https://hosts-file.net/ad_servers.txt - https://hosts-file.net/ad_servers.txt
# definition of whitelist groups. Attention: if the same group has black and whitelists, whitelists will be used to disable particular blacklist entries. If a group has only whitelist entries -> this means only domains from this list are allowed, all other domains will be blocked # definition of whitelist groups. Attention: if the same group has black and whitelists, whitelists will be used to disable particular blacklist entries. If a group has only whitelist entries -> this means only domains from this list are allowed, all other domains will be blocked
whiteLists: # whiteLists:
ads: # ads:
- whitelist.txt # - whitelist.txt
# definition: which groups should be applied for which client # definition: which groups should be applied for which client
clientGroupsBlock: clientGroupsBlock:
# default will be used, if no special definition for a client name exists # default will be used, if no special definition for a client name exists
@ -60,12 +60,12 @@ config:
- ads - ads
- special - special
# use client name or ip address # use client name or ip address
laptop.fritz.box: # laptop.fritz.box:
- ads # - ads
# which response will be sent, if query is blocked: # which response will be sent, if query is blocked:
# zeroIp: 0.0.0.0 will be returned (default) # zeroIp: 0.0.0.0 will be returned (default)
# nxDomain: return NXDOMAIN as return code # nxDomain: return NXDOMAIN as return code
blockType: zeroIp # blockType: zeroIp
# optional: automatically list refresh period in minutes. Default: 4h. # optional: automatically list refresh period in minutes. Default: 4h.
# Negative value -> deactivate automatically refresh. # Negative value -> deactivate automatically refresh.
# 0 value -> use default # 0 value -> use default
@ -73,37 +73,33 @@ config:
# optional: configuration for caching of DNS responses # optional: configuration for caching of DNS responses
# caching: # caching:
# amount in minutes, how long a response must be cached (min value). # # amount in minutes, how long a response must be cached (min value).
# If <=0, use response's TTL, if >0 use this value, if TTL is smaller # # If <=0, use response's TTL, if >0 use this value, if TTL is smaller
# Default: 0 # # Default: 0
# minTime: 40 # minTime: 40
# amount in minutes, how long a response must be cached (max value). # # amount in minutes, how long a response must be cached (max value).
# If <0, do not cache responses # # If <0, do not cache responses
# If 0, use TTL # # If 0, use TTL
# If > 0, use this value, if TTL is greater # # If > 0, use this value, if TTL is greater
# Default: 0 # # Default: 0
# maxTime: -1 # maxTime: -1
# optional: configuration of client name resolution # optional: configuration of client name resolution
clientLookup: # clientLookup:
# this DNS resolver will be used to perform reverse DNS lookup (typically local router) # # this DNS resolver will be used to perform reverse DNS lookup (typically local router)
upstream: udp:192.168.178.1 # upstream: udp:192.168.178.1
# optional: some routers return multiple names for client (host name and user defined name). Define which single name should be used. # # optional: some routers return multiple names for client (host name and user defined name). Define which single name should be used.
# Example: take second name if present, if not take first name # # Example: take second name if present, if not take first name
# singleNameOrder: # singleNameOrder:
# - 2 # - 2
# - 1 # - 1
# optional: configuration for prometheus metrics endpoint # optional: configuration for prometheus metrics endpoint
prometheus: prometheus:
# enabled if true # enabled if true
enable: true enable: true
# port, optional (default 4000)
# port: 4000
# url path, optional (default '/metrics') # url path, optional (default '/metrics')
path: /metrics path: /metrics
# optional: DNS listener port, default 53 (UDP and TCP)
port: 53
# optional: HTTP listener port, default 0 = no http listener. If > 0, will be used for prometheus metrics, pprof, ... # optional: HTTP listener port, default 0 = no http listener. If > 0, will be used for prometheus metrics, pprof, ...
httpPort: 4000 httpPort: 4000
# optional: Log level (one from debug, info, warn, error). Default: info # optional: Log level (one from debug, info, warn, error). Default: info