From: Pieter Lexis <pieter.lexis@powerdns.nl>
Date: Wed, 11 Mar 2015 13:31:32 +0000 (+0100)
Subject: Add documentation for the MyDNS backend
X-Git-Tag: dnsdist-1.0.0-alpha1~248^2~98^2~47^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F2357%2Fhead;p=thirdparty%2Fpdns.git

Add documentation for the MyDNS backend
---

diff --git a/docs/markdown/authoritative/backend-mydns.md b/docs/markdown/authoritative/backend-mydns.md
new file mode 100644
index 0000000000..6e6e4bae1c
--- /dev/null
+++ b/docs/markdown/authoritative/backend-mydns.md
@@ -0,0 +1,60 @@
+# MyDNS Backend
+|&nbsp;|&nbsp;|
+|:--|:--|
+|Native|Yes|
+|Master|No|
+|Slave|No|
+|Superslave|No|
+|Autoserial|No|
+|Case|Depends|
+|DNSSEC|No|
+|Disabled data|No|
+|Comments|No|
+|Module name|`mydns`|
+|Launch name|`mydns`|
+
+The MyDNS backend makes PowerDNS a drop-in replacement for the
+[MyDNS](http://mydns.bboy.net/) nameserver, as it uses the same database schema.
+
+## Configuration Parameters
+### `mydns-host`
+Database host to connect to.
+
+### `mydns-port`
+Port on the database server to connect to.
+
+### `mydns-dbname`
+Name of the database to connect to, "mydns" by default.
+
+### `mydns-user`
+User for the database, "powerdns" by default.
+
+### `mydns-password`
+The user password.
+
+### `mydns-socket`
+Unix socket to connect to the database.
+
+### `mydns-rr-table`
+Name of the resource record table in the database, "rr" by default.
+
+### `mydns-soa-table`
+Name of the SOA table in the database, "soa" by default.
+
+### `mydns-soa-where`
+Additional WHERE clause for SOA, default is "1 = 1".
+
+### `mydns-rr-where`
+Additional WHERE clause for resource records, default is "1 = 1".
+
+### `mydns-soa-active`
+Use the active column in the SOA table, "yes" by default.
+
+### `mydns-rr-active`
+Use the active column in the resource record table, "yes" by default.
+
+### `mydns-use-minimal-ttl`
+Setting this to 'yes' will make the backend behave like MyDNS on the TTL values.
+Setting it to 'no' will make it ignore the minimal-ttl of the zone. The default
+is "yes".
+
diff --git a/docs/markdown/authoritative/index.md b/docs/markdown/authoritative/index.md
index 656e079fc6..8d9f08314d 100644
--- a/docs/markdown/authoritative/index.md
+++ b/docs/markdown/authoritative/index.md
@@ -20,17 +20,18 @@ The following table describes the capabilities of the backends.
 | [LDAP](backend-ldap.md) | Unmaintained | Yes | No | No | No | No | No | Unknown (No) | Unknown (No) | Unknown |
 | [LMDB](backend-lmdb.md) | Supported | Yes | No | No | No | No | No | Unknown (No) | Unknown (No) | `lmdb`|
 | [MySQL](backend-generic-mypgsql.md) | Supported | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | `gmysql` |
+| [MyDNS](backend-mydns.md) | Supported | Yes | No | No | No | No | No | No | No | `mydns` |
 | [OpenDBX](backend-opendbx.md) | Supported | Yes | Yes | Yes | Yes | Unknown (No) | No | Unknown (No) | Unknown (No) | `opendbx` |
 | [Oracle](backend-oracle.md) | Supported | Yes | Yes | Yes | Yes | Yes | Yes | Unknown (No) | No | `oracle` |
 | [Pipe](backend-pipe.md) | Supported | Yes | No | No | No | No | Partial (no delegation, no key storage) | No | No | `pipe` |
 | [PostgreSQL](backend-generic-mypgsql.md) | Supported | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | `gpgsql` |
 | [Random](backend-random.md) | Supported | Yes | No | No | No | No | Yes (no key storage) | No | No | `random` |
-| [Remote](backend-remote.md) | Supported | Yes | Yes* | Yes* | Yes* | Yes* | Yes* | Unknown (No) | Unknown(No) | `remote` |
+| [Remote](backend-remote.md) | Supported | Yes | Yes\* | Yes\* | Yes\* | Yes\* | Yes\* | Unknown (No) | Unknown(No) | `remote` |
 | [SQLite](backend-gsqlite.md) 2 | Supported (not recommended) | Yes | Yes | Yes | Yes | No | No | No | No | `gsqlite` |
 | [SQLite](backend-gsqlite.md) 3 | Supported | Yes | Yes | Yes | Yes | Yes | Yes  | Yes | Yes | `gsqlite3` |
 | [TinyDNS](backend-tinydns.md) | Experimental | Yes | Yes | No | No | No | No | Unknown (No) | Unknown (No) | `tinydns` |
 
-*: Please read the backend-specific documentation.
+\*: Please read the backend-specific documentation.
 
 ### Native, Master, Slave, Superslave
 Which [Mode of Operation](modes-of-operation.md) (DNS data replication) is supported.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index c7af113033..688a95d060 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -32,6 +32,7 @@ pages:
   - [authoritative/backend-geo.md, 'Authoritative Backends', 'Geo(graphic loadbalancing)']
   - [authoritative/backend-geoip.md, 'Authoritative Backends', 'GeoIP']
   - [authoritative/backend-gsqlite.md, 'Authoritative Backends', 'Generic SQLite']
+  - [authoritative/backend-mydns.md, 'Authoritative Backends', 'MyDNS']
   - [authoritative/backend-ldap.md, 'Authoritative Backends', 'LDAP']
   - [authoritative/backend-lua.md, 'Authoritative Backends', 'Lua']
   - [authoritative/backend-lmdb.md, 'Authoritative Backends', 'LMDB']