Skip to content

Commit 7a54406

Browse files
authored
Use the same format logic throughout the document (#2029)
* Use the same spacing logic throughout the document * Fix previous commit * Fix previous commit, again * Use the same logic in comments too
1 parent bce0405 commit 7a54406

1 file changed

Lines changed: 67 additions & 68 deletions

File tree

dnscrypt-proxy/example-dnscrypt-proxy.toml

Lines changed: 67 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -454,20 +454,20 @@ cache_neg_max_ttl = 600
454454

455455
[query_log]
456456

457-
## Path to the query log file (absolute, or relative to the same directory as the config file)
458-
## Can be set to /dev/stdout in order to log to the standard output.
457+
## Path to the query log file (absolute, or relative to the same directory as the config file)
458+
## Can be set to /dev/stdout in order to log to the standard output.
459459

460-
# file = 'query.log'
460+
# file = 'query.log'
461461

462462

463-
## Query log format (currently supported: tsv and ltsv)
463+
## Query log format (currently supported: tsv and ltsv)
464464

465-
format = 'tsv'
465+
format = 'tsv'
466466

467467

468-
## Do not log these query types, to reduce verbosity. Keep empty to log everything.
468+
## Do not log these query types, to reduce verbosity. Keep empty to log everything.
469469

470-
# ignored_qtypes = ['DNSKEY', 'NS']
470+
# ignored_qtypes = ['DNSKEY', 'NS']
471471

472472

473473

@@ -481,14 +481,14 @@ cache_neg_max_ttl = 600
481481

482482
[nx_log]
483483

484-
## Path to the query log file (absolute, or relative to the same directory as the config file)
484+
## Path to the query log file (absolute, or relative to the same directory as the config file)
485485

486-
# file = 'nx.log'
486+
# file = 'nx.log'
487487

488488

489-
## Query log format (currently supported: tsv and ltsv)
489+
## Query log format (currently supported: tsv and ltsv)
490490

491-
format = 'tsv'
491+
format = 'tsv'
492492

493493

494494

@@ -511,19 +511,19 @@ cache_neg_max_ttl = 600
511511

512512
[blocked_names]
513513

514-
## Path to the file of blocking rules (absolute, or relative to the same directory as the config file)
514+
## Path to the file of blocking rules (absolute, or relative to the same directory as the config file)
515515

516-
# blocked_names_file = 'blocked-names.txt'
516+
# blocked_names_file = 'blocked-names.txt'
517517

518518

519-
## Optional path to a file logging blocked queries
519+
## Optional path to a file logging blocked queries
520520

521-
# log_file = 'blocked-names.log'
521+
# log_file = 'blocked-names.log'
522522

523523

524-
## Optional log format: tsv or ltsv (default: tsv)
524+
## Optional log format: tsv or ltsv (default: tsv)
525525

526-
# log_format = 'tsv'
526+
# log_format = 'tsv'
527527

528528

529529

@@ -539,19 +539,19 @@ cache_neg_max_ttl = 600
539539

540540
[blocked_ips]
541541

542-
## Path to the file of blocking rules (absolute, or relative to the same directory as the config file)
542+
## Path to the file of blocking rules (absolute, or relative to the same directory as the config file)
543543

544-
# blocked_ips_file = 'blocked-ips.txt'
544+
# blocked_ips_file = 'blocked-ips.txt'
545545

546546

547-
## Optional path to a file logging blocked queries
547+
## Optional path to a file logging blocked queries
548548

549-
# log_file = 'blocked-ips.log'
549+
# log_file = 'blocked-ips.log'
550550

551551

552-
## Optional log format: tsv or ltsv (default: tsv)
552+
## Optional log format: tsv or ltsv (default: tsv)
553553

554-
# log_format = 'tsv'
554+
# log_format = 'tsv'
555555

556556

557557

@@ -567,19 +567,19 @@ cache_neg_max_ttl = 600
567567

568568
[allowed_names]
569569

570-
## Path to the file of allow list rules (absolute, or relative to the same directory as the config file)
570+
## Path to the file of allow list rules (absolute, or relative to the same directory as the config file)
571571

572-
# allowed_names_file = 'allowed-names.txt'
572+
# allowed_names_file = 'allowed-names.txt'
573573

574574

575-
## Optional path to a file logging allowed queries
575+
## Optional path to a file logging allowed queries
576576

577-
# log_file = 'allowed-names.log'
577+
# log_file = 'allowed-names.log'
578578

579579

580-
## Optional log format: tsv or ltsv (default: tsv)
580+
## Optional log format: tsv or ltsv (default: tsv)
581581

582-
# log_format = 'tsv'
582+
# log_format = 'tsv'
583583

584584

585585

@@ -595,18 +595,18 @@ cache_neg_max_ttl = 600
595595

596596
[allowed_ips]
597597

598-
## Path to the file of allowed ip rules (absolute, or relative to the same directory as the config file)
598+
## Path to the file of allowed ip rules (absolute, or relative to the same directory as the config file)
599599

600-
# allowed_ips_file = 'allowed-ips.txt'
600+
# allowed_ips_file = 'allowed-ips.txt'
601601

602602

603-
## Optional path to a file logging allowed queries
603+
## Optional path to a file logging allowed queries
604604

605-
# log_file = 'allowed-ips.log'
605+
# log_file = 'allowed-ips.log'
606606

607-
## Optional log format: tsv or ltsv (default: tsv)
607+
## Optional log format: tsv or ltsv (default: tsv)
608608

609-
# log_format = 'tsv'
609+
# log_format = 'tsv'
610610

611611

612612

@@ -628,20 +628,20 @@ cache_neg_max_ttl = 600
628628
[schedules]
629629

630630
# [schedules.'time-to-sleep']
631-
# mon = [{after='21:00', before='7:00'}]
632-
# tue = [{after='21:00', before='7:00'}]
633-
# wed = [{after='21:00', before='7:00'}]
634-
# thu = [{after='21:00', before='7:00'}]
635-
# fri = [{after='23:00', before='7:00'}]
636-
# sat = [{after='23:00', before='7:00'}]
637-
# sun = [{after='21:00', before='7:00'}]
631+
# mon = [{after='21:00', before='7:00'}]
632+
# tue = [{after='21:00', before='7:00'}]
633+
# wed = [{after='21:00', before='7:00'}]
634+
# thu = [{after='21:00', before='7:00'}]
635+
# fri = [{after='23:00', before='7:00'}]
636+
# sat = [{after='23:00', before='7:00'}]
637+
# sun = [{after='21:00', before='7:00'}]
638638

639639
# [schedules.'work']
640-
# mon = [{after='9:00', before='18:00'}]
641-
# tue = [{after='9:00', before='18:00'}]
642-
# wed = [{after='9:00', before='18:00'}]
643-
# thu = [{after='9:00', before='18:00'}]
644-
# fri = [{after='9:00', before='17:00'}]
640+
# mon = [{after='9:00', before='18:00'}]
641+
# tue = [{after='9:00', before='18:00'}]
642+
# wed = [{after='9:00', before='18:00'}]
643+
# thu = [{after='9:00', before='18:00'}]
644+
# fri = [{after='9:00', before='17:00'}]
645645

646646

647647

@@ -726,16 +726,16 @@ cache_neg_max_ttl = 600
726726

727727
[broken_implementations]
728728

729-
# Cisco servers currently cannot handle queries larger than 1472 bytes, and don't
730-
# truncate responses larger than questions as expected by the DNSCrypt protocol.
731-
# This prevents large responses from being received over UDP and over relays.
732-
#
733-
# Older versions of the `dnsdist` server software had a bug with queries larger
734-
# than 1500 bytes. This is fixed since `dnsdist` version 1.5.0, but
735-
# some server may still run an outdated version.
736-
#
737-
# The list below enables workarounds to make non-relayed usage more reliable
738-
# until the servers are fixed.
729+
## Cisco servers currently cannot handle queries larger than 1472 bytes, and don't
730+
## truncate responses larger than questions as expected by the DNSCrypt protocol.
731+
## This prevents large responses from being received over UDP and over relays.
732+
##
733+
## Older versions of the `dnsdist` server software had a bug with queries larger
734+
## than 1500 bytes. This is fixed since `dnsdist` version 1.5.0, but
735+
## some server may still run an outdated version.
736+
##
737+
## The list below enables workarounds to make non-relayed usage more reliable
738+
## until the servers are fixed.
739739

740740
fragments_blocked = ['cisco', 'cisco-ipv6', 'cisco-familyshield', 'cisco-familyshield-ipv6', 'cleanbrowsing-adult', 'cleanbrowsing-adult-ipv6', 'cleanbrowsing-family', 'cleanbrowsing-family-ipv6', 'cleanbrowsing-security', 'cleanbrowsing-security-ipv6']
741741

@@ -745,15 +745,14 @@ fragments_blocked = ['cisco', 'cisco-ipv6', 'cisco-familyshield', 'cisco-familys
745745
# Certificate-based client authentication for DoH #
746746
#################################################################
747747

748-
# Use a X509 certificate to authenticate yourself when connecting to DoH servers.
749-
# This is only useful if you are operating your own, private DoH server(s).
750-
# 'creds' maps servers to certificates, and supports multiple entries.
751-
# If you are not using the standard root CA, an optional "root_ca"
752-
# property set to the path to a root CRT file can be added to a server entry.
748+
## Use a X509 certificate to authenticate yourself when connecting to DoH servers.
749+
## This is only useful if you are operating your own, private DoH server(s).
750+
## 'creds' maps servers to certificates, and supports multiple entries.
751+
## If you are not using the standard root CA, an optional "root_ca"
752+
## property set to the path to a root CRT file can be added to a server entry.
753753

754754
[doh_client_x509_auth]
755755

756-
#
757756
# creds = [
758757
# { server_name='*', client_cert='client.crt', client_key='client.key' }
759758
# ]
@@ -801,14 +800,14 @@ fragments_blocked = ['cisco', 'cisco-ipv6', 'cisco-familyshield', 'cisco-familys
801800
# ]
802801

803802

804-
# Skip resolvers incompatible with anonymization instead of using them directly
803+
## Skip resolvers incompatible with anonymization instead of using them directly
805804

806805
skip_incompatible = false
807806

808807

809-
# If public server certificates for a non-conformant server cannot be
810-
# retrieved via a relay, try getting them directly. Actual queries
811-
# will then always go through relays.
808+
## If public server certificates for a non-conformant server cannot be
809+
## retrieved via a relay, try getting them directly. Actual queries
810+
## will then always go through relays.
812811

813812
# direct_cert_fallback = false
814813

@@ -857,4 +856,4 @@ skip_incompatible = false
857856
[static]
858857

859858
# [static.'myserver']
860-
# stamp = 'sdns://AQcAAAAAAAAAAAAQMi5kbnNjcnlwdC1jZXJ0Lg'
859+
# stamp = 'sdns://AQcAAAAAAAAAAAAQMi5kbnNjcnlwdC1jZXJ0Lg'

0 commit comments

Comments
 (0)