encrypted-dns.toml -> example-encrypted-dns.toml

.github/workflows/rust.yml

@@ -21,7 +21,7 @@ jobs:
           env RUSTFLAGS="-C link-arg=-s" cargo build --release
           mkdir encrypted-dns
           mv target/release/encrypted-dns encrypted-dns/
-          cp README.md encrypted-dns.toml encrypted-dns/
+          cp README.md example-encrypted-dns.toml encrypted-dns/
       - uses: actions/upload-artifact@master
         with:
           name: encrypted-dns-linux-x86_64

.gitignore

@@ -3,3 +3,4 @@
 /target/
 Cargo.lock
 encrypted-dns.state
+encrypted-dns.toml

README.md

@@ -57,7 +57,9 @@ That resolver can run locally and only respond to `127.0.0.1`. External resolver
 
 In order to support DoH in addition to DNSCrypt, a DoH proxy must be running as well. [rust-doh](https://github.com/jedisct1/rust-doh) is the recommended DoH proxy server. DoH support is optional, as it is currently way more complicated to setup than DNSCrypt due to certificate management.
 
-Review the [`encrypted-dns.toml`](https://raw.githubusercontent.com/jedisct1/encrypted-dns-server/master/encrypted-dns.toml) configuration file. This is where all the parameters can be configured, including the IP addresses to listen to.
+First, make a copy of the `example-encrypted-dns.toml` configuration file named `encrypted.toml`.
+
+Then, review the [`encrypted-dns.toml`](https://raw.githubusercontent.com/jedisct1/encrypted-dns-server/master/encrypted-dns.toml) file. This is where all the parameters can be configured, including the IP addresses to listen to.
 
 You should probably at least change the `listen_addresses` and `provider_name` settings.
 

example-encrypted-dns.toml

@@ -14,10 +14,16 @@
 ## IP addresses and ports to listen to, as well as their external IP
 ## If there is no NAT involved, `local` and `external` can be the same.
 ## As many addresses as needed can be configured here, IPv4 and/or IPv6.
+## You should at least change the `external` IP address.
+
+### Example with both IPv4 and IPv6 addresses:
+# listen_addrs = [
+#     { local = "0.0.0.0:443",    external = "198.51.100.1:443" },
+#     { local = "[::]:443",       external = "[2001:db8::1]:443" }
+# ]
 
 listen_addrs = [
-    { local = "0.0.0.0:443",    external = "198.51.100.1:443" },
+    { local = "0.0.0.0:443",    external = "198.51.100.1:443" }
-    { local = "[::]:443",       external = "[2001:db8::1]:443" }
 ]