Add aliases to readme

2021-06-19 15:58:35 +01:00 · 2021-06-19 15:58:35 +01:00 · 12879324c6
commit 12879324c6
parent fc2031eb7c
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -65,6 +65,20 @@ zones:
        - 10 mta2.example.com
 ```

+## Aliases virtual type
+There is a virtual record type `aliases` which is a list of names to CNAME to this record.
+
+For example:
+
+```yaml
+zones:
+  example.com:
+    "@":
+      A: 10.54.22.9
+      aliases:
+        - www
+        - ftp
+```
 # Running
 Invoke the docker container with the input yaml file:
 ```bash