From: Pieter Lexis <pieter.lexis@powerdns.com>
Date: Sat, 30 Apr 2016 11:13:03 +0000 (+0200)
Subject: Add nproxy manpage, ship nproxy in pdns-tools deb
X-Git-Tag: rec-4.0.0-alpha3~19^2~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8b46f10e6487009ec4a15947d2165765bce0dc88;p=thirdparty%2Fpdns.git

Add nproxy manpage, ship nproxy in pdns-tools deb
---

diff --git a/build-scripts/build-auth-rpm b/build-scripts/build-auth-rpm
index 04b989dd13..e29c2dec52 100755
--- a/build-scripts/build-auth-rpm
+++ b/build-scripts/build-auth-rpm
@@ -257,6 +257,7 @@ fi
 %{_mandir}/man1/dumresp.1.gz
 %{_mandir}/man1/ixplore.1.gz
 %{_mandir}/man1/notify.1.gz
+%{_mandir}/man1/nproxy.1.gz
 %{_mandir}/man1/nsec3dig.1.gz
 %{_mandir}/man1/saxfr.1.gz
 %{_mandir}/man1/sdig.1.gz
@@ -532,6 +533,7 @@ exit 0
 %{_mandir}/man1/dumresp.1.gz
 %{_mandir}/man1/ixplore.1.gz
 %{_mandir}/man1/notify.1.gz
+%{_mandir}/man1/nproxy.1.gz
 %{_mandir}/man1/nsec3dig.1.gz
 %{_mandir}/man1/saxfr.1.gz
 %{_mandir}/man1/sdig.1.gz
@@ -790,6 +792,7 @@ exit 0
 %{_mandir}/man1/dumresp.1.gz
 %{_mandir}/man1/ixplore.1.gz
 %{_mandir}/man1/notify.1.gz
+%{_mandir}/man1/nproxy.1.gz
 %{_mandir}/man1/nsec3dig.1.gz
 %{_mandir}/man1/saxfr.1.gz
 %{_mandir}/man1/sdig.1.gz
diff --git a/build-scripts/debian-authoritative/pdns-tools.install b/build-scripts/debian-authoritative/pdns-tools.install
index f52da85c6f..d16e803f8c 100644
--- a/build-scripts/debian-authoritative/pdns-tools.install
+++ b/build-scripts/debian-authoritative/pdns-tools.install
@@ -9,6 +9,7 @@ usr/bin/dnswasher
 usr/bin/dumresp
 usr/bin/ixplore
 usr/bin/notify
+usr/bin/nproxy
 usr/bin/nsec3dig
 usr/bin/saxfr
 usr/bin/sdig
diff --git a/build-scripts/debian-authoritative/pdns-tools.manpages b/build-scripts/debian-authoritative/pdns-tools.manpages
index 268e9dcc35..2040cc283c 100644
--- a/build-scripts/debian-authoritative/pdns-tools.manpages
+++ b/build-scripts/debian-authoritative/pdns-tools.manpages
@@ -9,5 +9,6 @@ debian/tmp/usr/share/man/man1/dnswasher.1
 debian/tmp/usr/share/man/man1/dumresp.1
 debian/tmp/usr/share/man/man1/ixplore.1
 debian/tmp/usr/share/man/man1/notify.1
+debian/tmp/usr/share/man/man1/nproxy.1
 debian/tmp/usr/share/man/man1/nsec3dig.1
 debian/tmp/usr/share/man/man1/saxfr.1
diff --git a/docs/Makefile.am b/docs/Makefile.am
index cf8acee54d..179a241f03 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -16,6 +16,7 @@ MANPAGES_TARGET_TOOLS = calidns.1 \
 	dumresp.1 \
 	ixplore.1 \
 	notify.1 \
+	nproxy.1 \
 	nsec3dig.1 \
 	saxfr.1 \
 	sdig.1
diff --git a/docs/manpages/nproxy.1.md b/docs/manpages/nproxy.1.md
new file mode 100644
index 0000000000..ecaa15a204
--- /dev/null
+++ b/docs/manpages/nproxy.1.md
@@ -0,0 +1,54 @@
+% NPROXY(1)
+% PowerDNS.com BV
+% April 2016
+
+# NAME
+**nproxy** - DNS notification proxy
+
+# SYNOPSIS
+nproxy --powerdns-address *ADDRESS* [*OPTION*]... *ADDRESS*...
+
+# DESCRIPTION
+**nproxy** is a simple daemon that reads DNS NOTIFY queries on one address and
+forwards them to an 'inner' nameserver that will process the notification.
+
+Its usecase is e.g. a private authoritative server inside a NAT or firewalled LAN
+where **nproxy** is deployed in the DMZ.
+
+The PowerDNS Authoritative Server has the trusted-notification-proxy option that
+should be set to the address set with *--origin-address* to accept these proxied
+notifications.
+
+**nproxy** also has a health-check option built in. A query for 'pdns.nproxy.'
+with QType 'TXT' will be responded to with an answer of "OK" (inside the TXT record.
+When the query is for an A-record, '1.2.3.4.' is returned.
+
+# OPTIONS
+--powerdns-address *ADDRESS*
+:    IP address of the PowerDNS server to forward the notifications to.
+
+--chroot *PATH*
+:    chroot to *PATH* for additional security.
+
+--setuid *UID*
+:    setuid to this numerical *UID*.
+
+--setgid *GID*
+:    setgid to this numerical *GID*.
+
+--origin-address *ADDRESS*
+:    Set the source of the notifications sent to PowerDNS to *ADDRESS*. By default,
+     the best matching address (kernel's choice) is used.
+
+--listen-address *ADDRESS*
+:    IP addresses to listen on.
+
+--listen-port *PORT*
+:    Source port to listen on, 53 by default.
+
+-d,--daemon *ARG*
+:    Set *ARG* to 0 to disable running in the background.
+
+-v,--verbose
+:     Be verbose
+
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index a0860fd0dd..26671644ef 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -98,6 +98,7 @@ pages:
     - 'Manpage: dnstcpbench.1': manpages/dnstcpbench.1.md
     - 'Manpage: dnswasher.1': manpages/dnswasher.1.md
     - 'Manpage: notify.1': manpages/notify.1.md
+    - 'Manpage: nproxy.1': manpages/nproxy.1.md
     - 'Manpage: nsec3dig.1': manpages/nsec3dig.1.md
     - 'Manpage: saxfr.1': manpages/saxfr.1.md
     - 'Manpage: sdig.1': manpages/sdig.1.md