Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-11-02 10:13:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite using manpage style (#327)

Browse Source 
This still needs cleanup, but this is a first pass the cleans some
cruft and documents our style (in middleware.md) and makes all the
docs match that style.
This commit is contained in:
Miek Gieben
2016-10-10 20:13:22 +01:00
committed by GitHub
parent c22b7b2252
commit faf83b00dd
18 changed files with 154 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
middleware/file/README.md
View File

@@ -1,6 +1,6 @@
# file
`file` enables serving zone data from an RFC 1035-style master file.
*file* enables serving zone data from an RFC 1035-style master file.
The file middleware is used for an "old-style" DNS server. It serves from a preloaded file that exists
on disk. If the zone file contains signatures (i.e. is signed, i.e. DNSSEC) correct DNSSEC answers
@@ -10,27 +10,27 @@ zonefile.
## Syntax
~~~
file dbfile [zones...]
file DBFILE [ZONES...]
~~~
* `dbfile` the database file to read and parse.
* `zones` zones it should be authoritative for. If empty, the zones from the configuration block
* **DBFILE** the database file to read and parse.
* **ZONES** zones it should be authoritative for. If empty, the zones from the configuration block
are used.
If you want to round robin A and AAAA responses look at the `loadbalance` middleware.
If you want to round robin A and AAAA responses look at the *loadbalance* middleware.
TSIG key configuration is TODO; directive format for transfer will probably be extended with
TSIG key information, something like `transfer out [address...] key [name] [base64]`
TSIG key information, something like `transfer out [ADDRESS...] key [NAME[:ALG]] [BASE64]`
~~~
file dbfile [zones... ] {
transfer to [address...]
file DBFILE [ZONES... ] {
transfer to ADDRESS...
no_reload
}
~~~
* `transfer` enables zone transfers. It may be specified multiples times. *To* or *from* signals
the direction. Addresses must be denoted in CIDR notation (127.0.0.1/32 etc.) or just as plain
* `transfer` enables zone transfers. It may be specified multiples times. `To` or `from` signals
the direction. **ADDRESS** must be denoted in CIDR notation (127.0.0.1/32 etc.) or just as plain
addresses. The special wildcard `*` means: the entire internet (only valid for 'transfer to').
When an address is specified a notify message will be send whenever the zone is reloaded.
* `no_reload` by default CoreDNS will reload a zone from disk whenever it detects a change to the