aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ff4108f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# README for full_resolver
+## Overview
+Project `full_resolver` is part of a solution for blocking ads with dns null-routing. Specifically, this program is a troubleshooting tool for checking if a list of names are being blocked.
+
+## Using full_resolver
+Pass to standard input a list of domains, one per line. The program will resolve the domain names and display a custom output.
+This project was designed primarily for taking abbreviated output of a HAR file and turning it into IP addresses.
+
+ <input.har jq ".log.entries" | jq --raw-output "[.[] | .request.url] | sort | unique | .[]" | awk -F'/' '!x[$3]++ {print $3}' | ./full_resolver
+
+## Compiling full_resolver
+Use the provided Makefile.
+
+ make
+
+Accepted parameters include:
+1. DEBUG=1
+ This will set the C macro DEBUG so the debugging fprint instructions are included.
+
+## Dependencies
+[udns](http://www.corpit.ru/mjt/udns.html), found via [https://stackoverflow.com/questions/12328093/dns-lookup-in-c-c](https://stackoverflow.com/questions/12328093/dns-lookup-in-c-c)
+
+## References
+[1][file:///mnt/public/Support/Programs/dns/Troubleshooting-Adblocking-with-DNS.md]
+[2][] Web version of [reference 1][1]
bgstack15