From f791b246d0ba4e51feaa9d0bb3237ebad82edc75 Mon Sep 17 00:00:00 2001 From: Kegan Myers Date: Sat, 10 Oct 2020 11:54:19 -0500 Subject: [PATCH] add readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..14565d5 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# DNS over HTTPS stub resolver using DNSCrypt Proxy [![Build Status](https://jenkins.home.keganmyers.com/buildStatus/icon?job=doh-stub-dnscrypt-proxy-pipeline)](https://jenkins.home.keganmyers.com/job/doh-stub-dnscrypt-proxy-pipeline/) + +This is an alpine-based image running an instane of DNSCrpyt Proxy preconfigured to: + +- Use Cloudflare DNS over HTTPS servers +- Netprobe to 8.8.8.8 +- Read configuration from the `/data` directory (be sure to copy the default config, or only provide the individual `.txt` files through volumes) +- Listen on all interfaces for TCP and UDP on port 53 +- Not log any queries +- Send basic application logs (non-query logs) to stdout + +These are all decisions made in the context of operating a forwarding/stub resolver within docker for a small network.