summaryrefslogtreecommitdiff
path: root/config.md
diff options
context:
space:
mode:
authorPaul Holzinger <pholzing@redhat.com>2022-08-01 10:46:37 +0200
committerPaul Holzinger <pholzing@redhat.com>2022-08-01 10:46:37 +0200
commita1ba66f883bf23c62351ae8a5334a5291637d757 (patch)
tree50802792c21bcfb32dae529a99b9a1820aad36c6 /config.md
parent4d95bf1845358188c447bffaae9e22c90c0e8753 (diff)
document configuration format
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
Diffstat (limited to 'config.md')
-rw-r--r--config.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/config.md b/config.md
new file mode 100644
index 0000000..af40275
--- /dev/null
+++ b/config.md
@@ -0,0 +1,26 @@
+# Configuration format
+
+Aardvark-dns will read configuration files from a given directory.
+
+Inside this directory there should be at least one config file. The name of the file equals the network name.
+
+The first line in the config must contain a comma separated list of listening ips for this network, usually the bridge ips.
+At least one ip must be given.
+
+All following lines must contain the dns entries in this format:
+```
+[containerID][space][comma sparated ipv4 list][space][comma separated ipv6 list][space][comma separated dns names]
+```
+
+Aardvark-dns will reload all config files when receiving a SIGHUB signal.
+
+
+## Example
+
+```
+10.0.0.1,fdfd::1
+f35256b5e2f72ec8cb7d974d4f8841686fc8921fdfbc867285b50164e313f715 10.0.0.2 fdfd::2 testmulti1
+e5df0cdbe0136a30cc3e848d495d2cc6dada25b7dedc776b4584ce2cbba6f06f 10.0.0.3 fdfd::3 testmulti2
+```
+
+Also see [./src/test/config/](./src/test/config/) for more config examples