plugin/root/README.md

# root

## Name

*root* - simply specifies the root of where to find (zone) files.

## Description

The default root is the current working directory of CoreDNS. The *root* plugin allows you to change
this. A relative root path is relative to the current working directory.

## Syntax

~~~ txt
root PATH
~~~

**PATH** is the directory to set as CoreDNS' root.

## Examples

Serve zone data (when the *file* plugin is used) from `/etc/coredns/zones`:

~~~ corefile
. {
    root /etc/coredns/zones
}
~~~
middleware/root: add it (#330) This PR adds the root middleware that specifies a path where all zone file (the file middleware is the only consumer now) can be found. It works the same as in Caddy. Documentation can be found in the README.md of the middleware. Fixes #307 2016-10-11 20:42:28 +01:00			`# root`

Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages. 2018-01-04 12:53:07 +00:00			`## Name`
Fix all READMEs and some other fluff (#788) 2017-07-24 08:24:53 -07:00
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages. 2018-01-04 12:53:07 +00:00			`root - simply specifies the root of where to find (zone) files.`

			`## Description`

			`The default root is the current working directory of CoreDNS. The root plugin allows you to change`
			`this. A relative root path is relative to the current working directory.`
middleware/root: add it (#330) This PR adds the root middleware that specifies a path where all zone file (the file middleware is the only consumer now) can be found. It works the same as in Caddy. Documentation can be found in the README.md of the middleware. Fixes #307 2016-10-11 20:42:28 +01:00
			`## Syntax`

			`~~~ txt`
			`root PATH`
			`~~~`

			`PATH is the directory to set as CoreDNS' root.`

			`## Examples`

Remove the word middleware (#1067) * Rename middleware to plugin first pass; mostly used 'sed', few spots where I manually changed text. This still builds a coredns binary. * fmt error * Rename AddMiddleware to AddPlugin * Readd AddMiddleware to remain backwards compat 2017-09-14 09:36:06 +01:00			Serve zone data (when the file plugin is used) from `/etc/coredns/zones`:
middleware/root: add it (#330) This PR adds the root middleware that specifies a path where all zone file (the file middleware is the only consumer now) can be found. It works the same as in Caddy. Documentation can be found in the README.md of the middleware. Fixes #307 2016-10-11 20:42:28 +01:00
plugins: expand examples (#1077) * plugins: expand examples Expand some examples and test them by annotating it with `corefile` * Can't start kubernetes * Can test pprof :( 2017-09-15 09:56:05 +01:00			`~~~ corefile`
			`. {`
			`root /etc/coredns/zones`
			`}`
middleware/root: add it (#330) This PR adds the root middleware that specifies a path where all zone file (the file middleware is the only consumer now) can be found. It works the same as in Caddy. Documentation can be found in the README.md of the middleware. Fixes #307 2016-10-11 20:42:28 +01:00			`~~~`