loweel
/
zabov
1
0
Fork 1
Code Issues Pull Requests Projects Releases 2 Wiki Activity

- added whitelist documentation

pull/3/head
bloved 2021-05-11 10:36:00 +02:00
parent ef9f912cf7
commit 2fe0b7b0c2
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -63,6 +63,7 @@ Minimal config file should look like:
"doublefilters":"./urls-hosts.txt", "doublefilters":"./urls-hosts.txt",
"blackholeip":"127.0.0.1", "blackholeip":"127.0.0.1",
"hostsfile":"./urls-local.txt", "hostsfile":"./urls-local.txt",
"whitelist":"./whitelist.txt",
"cache":true "cache":true
}, },
} }
@ -85,6 +86,7 @@ configs:
- doublefilters: name of the file, for blacklists following the "doublefilter" 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 - 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 blacklist file : 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 - 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: 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", "singlefilters":"./urls-domains.txt",
"doublefilters":"./urls-hosts.txt", "doublefilters":"./urls-hosts.txt",
"blackholeip":"127.0.0.1", "blackholeip":"127.0.0.1",
"hostsfile":"./urls-local.txt" "hostsfile":"./urls-local.txt",
"whitelist":"./whitelist.txt",
}, },
"children":{ "children":{
"upstream":"./dns-upstream-safe.txt", "upstream":"./dns-upstream-safe.txt",
"singlefilters":"./urls-domains.txt", "singlefilters":"./urls-domains.txt",
"doublefilters":"./urls-hosts.txt", "doublefilters":"./urls-hosts.txt",
"blackholeip":"127.0.0.1", "blackholeip":"127.0.0.1",
"hostsfile":"./urls-local.txt" "hostsfile":"./urls-local.txt",
"whitelist":"./whitelist.txt",
}, },
"children_restricted":{ "children_restricted":{
"upstream":"./dns-upstream-safe.txt", "upstream":"./dns-upstream-safe.txt",
"singlefilters":"./urls-domains-restricted.txt", "singlefilters":"./urls-domains-restricted.txt",
"doublefilters":"./urls-hosts-restricted.txt", "doublefilters":"./urls-hosts-restricted.txt",
"blackholeip":"127.0.0.1", "blackholeip":"127.0.0.1",
"hostsfile":"./urls-local.txt" "hostsfile":"./urls-local.txt",
"whitelist":"./whitelist.txt",
}, },
"tv":{ "tv":{
"upstream":"./dns-upstream.txt", "upstream":"./dns-upstream.txt",
@ -160,6 +165,7 @@ Advanced configuration includes support for multiple configurations based on IP
"doublefilters":"", "doublefilters":"",
"blackholeip":"127.0.0.1", "blackholeip":"127.0.0.1",
"hostsfile":"", "hostsfile":"",
"whitelist":"",
"cache":false "cache":false
} }
} }