From 38a1e371e10bf2f51ecc67d56946cf17809e9d5e Mon Sep 17 00:00:00 2001 From: Nico D'Cotta <45274424+Cottand@users.noreply.github.com> Date: Wed, 13 Dec 2023 20:21:28 +0000 Subject: [PATCH] docs: document a smaller quick start config (#44) --- doc/src/Configuration.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/doc/src/Configuration.md b/doc/src/Configuration.md index 17c7635..1a6aa9e 100644 --- a/doc/src/Configuration.md +++ b/doc/src/Configuration.md @@ -1,6 +1,35 @@ If leng.toml is not found the default configuration will be used. If it is found, fields that are set will act as overrides. -Here is the default configuration: +## Quick Start + +If you are happy to use Cloudflare as your upstream DNS provider and just want to generally block tracking +and advertising, the following minimal config should be enough. + +If you want to tweak more settings, keep scrolling down! + +```toml +# address to bind to for the DNS server +bind = "0.0.0.0:53" + +# address to bind to for the API server +api = "127.0.0.1:8080" + +# manual custom dns entries - comments for reference +customdnsrecords = [ + # "example.mywebsite.tld IN A 10.0.0.1", +] + +[Metrics] + enabled = false + +[Blocking] + # manual whitelist entries - comments for reference + whitelist = [ + # "getsentry.com", + ] +``` + +## Default configuration ```toml # log configuration