From 2fe0b7b0c29f640ae03afdb85a12d31097fdf773 Mon Sep 17 00:00:00 2001 From: bloved Date: Tue, 11 May 2021 10:36:00 +0200 Subject: [PATCH] - added whitelist documentation --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 13aee9a..1dca7de 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ Minimal config file should look like: "doublefilters":"./urls-hosts.txt", "blackholeip":"127.0.0.1", "hostsfile":"./urls-local.txt", + "whitelist":"./whitelist.txt", "cache":true }, } @@ -84,7 +85,8 @@ configs: - singlefilters: name of the file for blacklists following the "singlefilter" schema.(one URL per line) - doublefilters: name of the file, for blacklists following the "doublefilter" schema.(one URL per line) - blackholeip: IP address to return when the IP is banned. This is because you may want to avoid MX issues, mail loops on localhost, or you have a web server running on localhost -- hostsfile: path where you keep your local blacklistfile : this is in the format "singlefilter", meaning one domain per line, unlike hosts file. +- hostsfile: path where you keep your local blacklist file : this is in the format "singlefilter", meaning one domain per line, unlike hosts file. +- whitelist: path where you keep your local whitelist file : this is in the format "singlefilter", meaning one domain per line, unlike hosts file. - cache: if set to false disable the cache for this configuration. Boolean, defaults true Advanced configuration includes support for multiple configurations based on IP Source and timetables: @@ -138,21 +140,24 @@ Advanced configuration includes support for multiple configurations based on IP "singlefilters":"./urls-domains.txt", "doublefilters":"./urls-hosts.txt", "blackholeip":"127.0.0.1", - "hostsfile":"./urls-local.txt" + "hostsfile":"./urls-local.txt", + "whitelist":"./whitelist.txt", }, "children":{ "upstream":"./dns-upstream-safe.txt", "singlefilters":"./urls-domains.txt", "doublefilters":"./urls-hosts.txt", "blackholeip":"127.0.0.1", - "hostsfile":"./urls-local.txt" + "hostsfile":"./urls-local.txt", + "whitelist":"./whitelist.txt", }, "children_restricted":{ "upstream":"./dns-upstream-safe.txt", "singlefilters":"./urls-domains-restricted.txt", "doublefilters":"./urls-hosts-restricted.txt", "blackholeip":"127.0.0.1", - "hostsfile":"./urls-local.txt" + "hostsfile":"./urls-local.txt", + "whitelist":"./whitelist.txt", }, "tv":{ "upstream":"./dns-upstream.txt", @@ -160,6 +165,7 @@ Advanced configuration includes support for multiple configurations based on IP "doublefilters":"", "blackholeip":"127.0.0.1", "hostsfile":"", + "whitelist":"", "cache":false } }