{"id":13552018,"url":"https://github.com/DNSCrypt/encrypted-dns-server","last_synced_at":"2025-04-03T02:32:41.309Z","repository":{"id":37010537,"uuid":"205726729","full_name":"DNSCrypt/encrypted-dns-server","owner":"DNSCrypt","description":"An easy to install, high-performance, zero maintenance proxy to run an encrypted DNS server.","archived":false,"fork":false,"pushed_at":"2024-09-16T04:45:50.000Z","size":564,"stargazers_count":954,"open_issues_count":13,"forks_count":93,"subscribers_count":38,"default_branch":"master","last_synced_at":"2024-09-17T23:47:53.564Z","etag":null,"topics":["anonymized","dns","dnscrypt","doh","privacy","proxy","server"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DNSCrypt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"dnscrypt"}},"created_at":"2019-09-01T20:07:18.000Z","updated_at":"2024-09-17T08:21:16.000Z","dependencies_parsed_at":"2024-01-17T14:20:29.448Z","dependency_job_id":"72a65347-8fd5-41fb-b09d-d069da668319","html_url":"https://github.com/DNSCrypt/encrypted-dns-server","commit_stats":null,"previous_names":["jedisct1/encrypted-dns-server"],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DNSCrypt%2Fencrypted-dns-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DNSCrypt%2Fencrypted-dns-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DNSCrypt%2Fencrypted-dns-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DNSCrypt%2Fencrypted-dns-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DNSCrypt","download_url":"https://codeload.github.com/DNSCrypt/encrypted-dns-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222911647,"owners_count":17056714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["anonymized","dns","dnscrypt","doh","privacy","proxy","server"],"created_at":"2024-08-01T12:01:57.568Z","updated_at":"2024-11-03T22:33:10.792Z","avatar_url":"https://github.com/DNSCrypt.png","language":"Rust","funding_links":["https://opencollective.com/dnscrypt"],"categories":["Rust","server"],"sub_categories":[],"readme":"# ![Encrypted DNS Server](logo.png)\n![Github CI status](https://img.shields.io/github/actions/workflow/status/jedisct1/encrypted-dns-server/test.yml?branch=master)\n[![Gitter chat](https://badges.gitter.im/gitter.svg)](https://gitter.im/dnscrypt-operators/Lobby)\n\nAn easy to install, high-performance, zero maintenance proxy to run an encrypted DNS server.\n\n![Dashboard](dashboard.png)\n\n## Protocols\n\nThe proxy supports the following protocols:\n\n- [DNSCrypt v2](https://github.com/DNSCrypt/dnscrypt-protocol/blob/master/DNSCRYPT-V2-PROTOCOL.txt)\n- [Anonymized DNSCrypt](https://github.com/DNSCrypt/dnscrypt-protocol/blob/master/ANONYMIZED-DNSCRYPT.txt)\n- DNS-over-HTTP (DoH) forwarding\n\nAll of these can be served simultaneously, on the same port (usually port 443). The proxy automatically detects what protocol is being used by each client.\n\n## Installation\n\n### Option 1: precompiled x86_64 binary\n\nDebian packages, archives for Linux and Windows [can be downloaded here](https://github.com/jedisct1/encrypted-dns-server/releases/latest).\n\nNothing else has to be installed. The server doesn't require any external dependencies.\n\nIn the Debian package, the example configuration file can be found in `/usr/share/doc/encrypted-dns/`.\n\n### Option 2: compilation from source code\n\nThe proxy requires rust \u003e= 1.0.39 or rust-nightly.\n\nRust can installed with:\n\n```sh\ncurl -sSf https://sh.rustup.rs | bash -s -- -y --default-toolchain nightly\nsource $HOME/.cargo/env\n```\n\nOnce rust is installed, the proxy can be compiled and installed as follows:\n\n```sh\ncargo install encrypted-dns\nstrip ~/.cargo/bin/encrypted-dns\n```\n\nThe executable file will be copied to `~/.cargo/bin/encrypted-dns` by default.\n\n### Options 3: Docker\n\n[dnscrypt-server-docker](https://github.com/dnscrypt/dnscrypt-server-docker) is the most popular way to deploy an encrypted DNS server.\n\nThis Docker image that includes a caching DNS resolver, the encrypted DNS proxy, and scripts to automatically configure everything.\n\n## Setup\n\nThe proxy requires a recursive DNS resolver, such as Knot, PowerDNS or Unbound.\n\nThat resolver can run locally and only respond to `127.0.0.1`. External resolvers such as Quad9 or Cloudflare DNS can also be used, but this may be less reliable due to rate limits.\n\nIn 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.\n\nMake a copy of the `example-encrypted-dns.toml` configuration file named `encrypted-dns.toml`.\n\nThen, review the [`encrypted-dns.toml`](https://raw.githubusercontent.com/jedisct1/encrypted-dns-server/master/example-encrypted-dns.toml) file. This is where all the parameters can be configured, including the IP addresses to listen to.\n\nYou should probably at least change the `listen_addrs` and `provider_name` settings.\n\nStart the proxy. It will automatically create a new provider key pair if there isn't any.\n\nThe DNS stamps are printed. They can be used directly with [`dnscrypt-proxy`](https://github.com/dnscrypt/dnscrypt-proxy/).\n\nThere is nothing else to do. Certificates are automatically generated and rotated.\n\n## Migrating from dnscrypt-wrapper\n\nIf you are currently running an encrypted DNS server using [`dnscrypt-wrapper`](https://github.com/cofyc/dnscrypt-wrapper), moving to the new proxy is simple:\n\n- Double check that the provider name in `encrypted-dns.toml` matches the one you previously configured. If you forgot it, it can be recovered [from its DNS stamp](https://dnscrypt.info/stamps/).\n- Run `encrypted-dns --import-from-dnscrypt-wrapper secret.key`, with `secret.key` being the file with the `dnscrypt-wrapper` provider secret key.\n\nDone. Your server is now running the new proxy.\n\n## Built-in DNS cache\n\nThe proxy includes a key cache, as well as a DNS cache to significantly reduce the load on upstream servers.\n\nIn addition, if a server is slow or unresponsive, expired cached queries will be returned, ensuring that popular domain names always keep being served.\n\n## State file\n\nThe proxy creates and updates a file named `encrypted-dns.state` by default. That file contains the provider secret key, as well as certificates and encryption keys.\n\nDo not delete the file, unless you want to change parameters (such as the provider name), and keep it secret, or the keys will be lost.\n\nPutting it in a directory that is only readable by the super-user is not a bad idea.\n\n## Filtering\n\nDomains can be filtered directly by the proxy, see the `[filtering]` section of the configuration file. Note: Filtering only works with the DNSCrypt protocol and does not apply to DNS-over-HTTP (DoH) forwarding.\n\n## Access control\n\nAccess control can be enabled in the `[access_control]` section and configured with the `query_meta` configuration value of `dnscrypt-proxy`.\n\n## Prometheus metrics\n\nPrometheus metrics can optionally be enabled in order to monitor performance, cache efficiency, and more.\n\n## Anonymized DNSCrypt\n\nEnabling Anonymized DNSCrypt allows the server to be used as an encrypted DNS relay.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDNSCrypt%2Fencrypted-dns-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDNSCrypt%2Fencrypted-dns-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDNSCrypt%2Fencrypted-dns-server/lists"}