diff --git a/README.md b/README.md index 40d4018..f204a11 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# DNS-over-HTTPS Proxy (`doh-proxy`) +# DNS-over-HTTPS Proxy (`dohproxy`) A simple DNS-over-HTTPS (DoH) proxy server written in Go. This tool acts as an intermediary between a DNS client and one or more DNS-over-HTTPS servers, forwarding DNS queries over HTTP/2 and handling responses. @@ -19,21 +19,21 @@ A simple DNS-over-HTTPS (DoH) proxy server written in Go. This tool acts as an i 1. Clone this repository: ```sh - git clone https://git.olympuslab.net/afonso/doh-proxy - cd doh-proxy + git clone https://git.olympuslab.net/afonso/dohproxy + cd dohproxy ``` 2. Build the Go executable: ```sh - go build doh-proxy.go + go build dohproxy.go ``` ### Usage -Run the `doh-proxy` with the following options: +Run the `dohproxy` with the following options: ```sh -./doh-proxy [options] +./dohproxy [options] ``` #### Options @@ -49,13 +49,13 @@ Run the `doh-proxy` with the following options: To start the proxy on `localhost` at port `5353`, listening on both TCP and UDP (uses both by default), with two upstream DoH servers and logging enabled: ```sh -./doh-proxy -l 127.0.0.1 -p 5353 -tcp -udp -log -u https://dns.quad9.net/dns-query -u https://1.1.1.1/dns-query +./dohproxy -l 127.0.0.1 -p 5353 -tcp -udp -log -u https://dns.quad9.net/dns-query -u https://1.1.1.1/dns-query ``` ### Important Note -- You need to run doh-proxy as root to use lower ports (such as 53). +- You need to run dohproxy as root to use lower ports (such as 53). - At least one upstream DoH server URL is required for the proxy to function. - If this proxy is used as your system's default DNS resolver and the upstream server URL is a domain name, at least one other DNS server must be specified as an IP address to avoid circular dependency issues. diff --git a/doh-proxy.go b/dohproxy.go similarity index 100% rename from doh-proxy.go rename to dohproxy.go