Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme: use a 3rd column for default values #28

Merged
merged 1 commit into from
Jan 15, 2023
Merged

readme: use a 3rd column for default values #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,24 +70,24 @@ go install github.com/shoenig/donutdns@latest

The `donutdns` executable uses environment variables for configuration.

| Environment Variable | Description |
| -------------------- | ----------- |
| `DONUT_DNS_PORT` | The port to listen to (default `5301`) |
| `DONUT_DNS_NO_DEBUG` | Disable CoreDNS debug logging (default unset) |
| `DONUT_DNS_NO_LOG` | Disable CoreDNS logging (default unset) |
| `DONUT_DNS_ALLOW` | Comma separated list of domains to NOT block (default unset) |
| `DONUT_DNS_ALLOW_FILE` | File with list of domains to NOT block (default unset) |
| `DONUT_DNS_ALLOW_DIR` | Directory with one or more files of list of domains to NOT block (default unset) |
| `DONUT_DNS_BLOCK` | Comma separated list of domains to block (default unset) |
| `DONUT_DNS_BLOCK_FILE` | File with list of domains to block (default unset) |
| `DONUT_DNS_BLOCK_DIR` | Directory with one or more files of list of domains to block (default unset) |
| `DONUT_DNS_SUFFIX` | Comma separated list of domains to block by suffix (default unset) |
| `DONUT_DNS_SUFFIX_FILE` | File with list of domains to block by suffix (default unset) |
| `DONUT_DNS_SUFFIX_DIR` | Directory with one or more files of list of domains to block by suffix (default unset) |
| `DONUT_DNS_NO_DEFAULTS` | Disable blocking of default domain block lists (default unset) |
| `DONUT_DNS_UPSTREAM_1` | Fallback DNS Server for non-blocked queries (default `1.1.1.1`) |
| `DONUT_DNS_UPSTREAM_2` | Fallback DNS Server for non-blocked queries (default `1.0.0.1`) |
| `DONUT_DNS_UPSTREAM_NAME` | Fallback DNS Server TLS name (default `cloudflare-dns.com`) |
| Environment Variable | Description | Default |
| -------------------- | ----------- | ------- |
| `DONUT_DNS_PORT` | The port to listen on | `5301` |
| `DONUT_DNS_NO_DEBUG` | Disable CoreDNS debug logging | unset |
| `DONUT_DNS_NO_LOG` | Disable CoreDNS logging | unset |
| `DONUT_DNS_ALLOW` | Comma separated list of domains to NOT block | unset |
| `DONUT_DNS_ALLOW_FILE` | File with list of domains to NOT block | unset |
| `DONUT_DNS_ALLOW_DIR` | Directory with one or more files of list of domains to NOT block | unset |
| `DONUT_DNS_BLOCK` | Comma separated list of domains to block | unset |
| `DONUT_DNS_BLOCK_FILE` | File with list of domains to block | unset |
| `DONUT_DNS_BLOCK_DIR` | Directory with one or more files of list of domains to block | unset |
| `DONUT_DNS_SUFFIX` | Comma separated list of domains to block by suffix | unset |
| `DONUT_DNS_SUFFIX_FILE` | File with list of domains to block by suffix | unset |
| `DONUT_DNS_SUFFIX_DIR` | Directory with one or more files of list of domains to block by suffix | unset |
| `DONUT_DNS_NO_DEFAULTS` | Disable blocking of default domain block lists | unset |
| `DONUT_DNS_UPSTREAM_1` | Fallback DNS Server for non-blocked queries |`1.1.1.1` |
| `DONUT_DNS_UPSTREAM_2` | Fallback DNS Server for non-blocked queries | `1.0.0.1` |
| `DONUT_DNS_UPSTREAM_NAME` | Fallback DNS Server TLS name | `cloudflare-dns.com` |

#### CoreDNS Plugin

Expand Down