commit d28a9ab9ad2f0c468e8c40b4689819db27aa1a52
parent 21e7c3fa5f1dc7bdac5c3bf2f5853465b1ac3551
Author: Frederic Cambus <fred@statdns.com>
Date: Wed, 24 Feb 2016 22:39:52 +0100
Formatting fixes
Diffstat:
| M | README.md | | | 246 | ++++++++++++++++++++++++++++++++++++++++---------------------------------------- |
1 file changed, 123 insertions(+), 123 deletions(-)
diff --git a/README.md b/README.md
@@ -1,44 +1,44 @@
- ______ ____________________.
- / / / |
- / . / | R
- ________ ____/___ __/_____ _____ |
- __ __\__ /__\__ /__\__ /__\\__ \__ | R
- /// _/ // _/ // |/ \\ ._ \ |
- _/ \ \_ \ \_ ' /_ |/ // | D
- \_____/_____/___/_____/__________/____/ /_ |
- <---------h7/dS!---- \ . \ -------\\______/ | A
- \ \ \ |
- \______\ \____________________|
-
-## Description
-
-RRDA is a REST API written in Go allowing to perform DNS queries over HTTP, and to get reverse PTR records for both IPv4 and IPv6 addresses. It outputs JSON-encoded DNS responses.
+ ______ ____________________.
+ / / / |
+ / . / | R
+ ________ ____/___ __/_____ _____ |
+ __ __\__ /__\__ /__\__ /__\\__ \__ | R
+ /// _/ // _/ // |/ \\ ._ \ |
+ _/ \ \_ \ \_ ' /_ |/ // | D
+ \_____/_____/___/_____/__________/____/ /_ |
+ <---------h7/dS!---- \ . \ -------\\______/ | A
+ \ \ \ |
+ \______\ \____________________|
+
+## Description
+
+RRDA is a REST API written in Go allowing to perform DNS queries over HTTP, and to get reverse PTR records for both IPv4 and IPv6 addresses. It outputs JSON-encoded DNS responses.
The API allows to specify which name server to query (either recursive or authoritative), and can be used as a foundation to build DNS looking glasses.
-
-RRDA is a recursive acronym for "RRDA REST DNS API".
-
-## Requirements
-
-RRDA requires the following Go libraries :
-
-- dns : DNS library in Go - https://github.com/miekg/dns
-- pat : pattern muxer for Go - https://github.com/bmizerany/pat
-
-## Installation
-
-Build and install with the `go` tool, all dependencies will be automatically fetched and compiled :
-
+
+RRDA is a recursive acronym for "RRDA REST DNS API".
+
+## Requirements
+
+RRDA requires the following Go libraries :
+
+- dns : DNS library in Go - https://github.com/miekg/dns
+- pat : pattern muxer for Go - https://github.com/bmizerany/pat
+
+## Installation
+
+Build and install with the `go` tool, all dependencies will be automatically fetched and compiled :
+
go get -d -v ./... && go build -v ./...
- go install rrda
-
-## Usage
-
-By default, RRDA will bind on localhost, port 8080.
-
- Usage of ./rrda:
- -host="127.0.0.1": Set the server host
- -port="8080": Set the server port
+ go install rrda
+
+## Usage
+
+By default, RRDA will bind on localhost, port 8080.
+
+ Usage of ./rrda:
+ -host="127.0.0.1": Set the server host
+ -port="8080": Set the server port
## Running RRDA at boot time
@@ -61,63 +61,63 @@ Copy the `freebsd/rrda` file in `/usr/local/etc/rc.d` and the RRDA binary in `/u
To launch the daemon at startup, add the following line in `/etc/rc.conf` :
rrda_enable="YES"
-
-## Making Queries
-
-The following examples assume there is a resolver on localhost listening on port 53.
-
-### Getting Resources Records
-
-URL Scheme : http://server:port/resolver:port/domain/querytype
-
-- Example (using an IPv4 resolver) : http://127.0.0.1:8080/127.0.0.1:53/example.org/ns
-- Example (using an IPv6 resolver) : http://127.0.0.1:8080/[::1]:53/example.org/ns
-
-### Getting Reverse PTR Records (for both IPv4 and IPv6 addresses)
-
-URL Scheme : http://server:port/resolver:port/x/ip
-
-- Example (IPv4) : http://127.0.0.1:8080/127.0.0.1:53/x/193.0.6.139
-- Example (IPv6) : http://127.0.0.1:8080/127.0.0.1:53/x/2001:67c:2e8:22::c100:68b
+
+## Making Queries
+
+The following examples assume there is a resolver on localhost listening on port 53.
+
+### Getting Resources Records
+
+URL Scheme : http://server:port/resolver:port/domain/querytype
+
+- Example (using an IPv4 resolver) : http://127.0.0.1:8080/127.0.0.1:53/example.org/ns
+- Example (using an IPv6 resolver) : http://127.0.0.1:8080/[::1]:53/example.org/ns
+
+### Getting Reverse PTR Records (for both IPv4 and IPv6 addresses)
+
+URL Scheme : http://server:port/resolver:port/x/ip
+
+- Example (IPv4) : http://127.0.0.1:8080/127.0.0.1:53/x/193.0.6.139
+- Example (IPv6) : http://127.0.0.1:8080/127.0.0.1:53/x/2001:67c:2e8:22::c100:68b
## JSONP Support
RRDA supports JSONP callbacks.
-- Example : http://127.0.0.1:8080/127.0.0.1:53/example.org/ns?callback=rrda
-
-## JSON Output Schema
-
-The output is a JSON object containing the following arrays, representing the appropriate sections of DNS packets :
-
-- question
-- answer
-- authority (omitted if empty)
-- additional (omitted if empty)
-
-### Question section
-
-- name
-- type
-- class
-
-### Answer, Authority, Additional sections
-
-- name
-- type
-- class
-- ttl
-- rdlength
-- rdata
-
-## Client Errors
-
-When incorrect user input is entered, the server returns an HTTP 400 Error (Bad Request), along with a JSON-encoded error message.
-
-- Code 401 : Input string could not be parsed
-- Code 402 : Input string is not a well-formed domain name
-- Code 403 : Input string is not a valid IP address
-- Code 404 : Invalid DNS query type
+- Example : http://127.0.0.1:8080/127.0.0.1:53/example.org/ns?callback=rrda
+
+## JSON Output Schema
+
+The output is a JSON object containing the following arrays, representing the appropriate sections of DNS packets :
+
+- question
+- answer
+- authority (omitted if empty)
+- additional (omitted if empty)
+
+### Question section
+
+- name
+- type
+- class
+
+### Answer, Authority, Additional sections
+
+- name
+- type
+- class
+- ttl
+- rdlength
+- rdata
+
+## Client Errors
+
+When incorrect user input is entered, the server returns an HTTP 400 Error (Bad Request), along with a JSON-encoded error message.
+
+- Code 401 : Input string could not be parsed
+- Code 402 : Input string is not a well-formed domain name
+- Code 403 : Input string is not a valid IP address
+- Code 404 : Invalid DNS query type
### Examples
@@ -129,15 +129,15 @@ When incorrect user input is entered, the server returns an HTTP 400 Error (Bad
curl http://127.0.0.1:8080/:53/statdns.net/error
{"code":404,"message":"Invalid DNS query type"}
-
-## Server Errors
-
-When the DNS server cannot be reached or returns an error, the server returns an HTTP 500 Error (Internal Server Error), along with a JSON-encoded error message.
-
-- Code 501 : DNS server could not be reached
-- Code 502 : The name server encountered an internal failure while processing this request (SERVFAIL)
-- Code 503 : Some name that ought to exist, does not exist (NXDOMAIN)
-- Code 505 : The name server refuses to perform the specified operation for policy or security reasons (REFUSED)
+
+## Server Errors
+
+When the DNS server cannot be reached or returns an error, the server returns an HTTP 500 Error (Internal Server Error), along with a JSON-encoded error message.
+
+- Code 501 : DNS server could not be reached
+- Code 502 : The name server encountered an internal failure while processing this request (SERVFAIL)
+- Code 503 : Some name that ought to exist, does not exist (NXDOMAIN)
+- Code 505 : The name server refuses to perform the specified operation for policy or security reasons (REFUSED)
### Examples
@@ -152,27 +152,27 @@ When the DNS server cannot be reached or returns an error, the server returns an
curl http://127.0.0.1:8080/:53/lame.broken-on-purpose.generic-nic.net/soa
{"code":505,"message":"The name server refuses to perform the specified operation for policy or security reasons (REFUSED)"}
-
-## Sites using RRDA
-
-- StatDNS : Rest DNS API - http://www.statdns.com/api/
-- DNS-LG : Multilocation DNS Looking Glass - http://www.dns-lg.com
-
-## License
-
-RRDA is released under the BSD 3-Clause license. See `LICENSE` file for details.
-
-## Author
-
-RRDA is developed by Frederic Cambus
-
-- Site : http://www.cambus.net
-- Twitter: http://twitter.com/fcambus
-
-## Resources
-
-Project Homepage : http://www.statdns.com
-
-Latest tarball release : http://www.statdns.com/rrda/rrda-1.01.tar.gz
-
-GitHub : https://github.com/fcambus/rrda
+
+## Sites using RRDA
+
+- StatDNS : Rest DNS API - http://www.statdns.com/api/
+- DNS-LG : Multilocation DNS Looking Glass - http://www.dns-lg.com
+
+## License
+
+RRDA is released under the BSD 3-Clause license. See `LICENSE` file for details.
+
+## Author
+
+RRDA is developed by Frederic Cambus
+
+- Site : http://www.cambus.net
+- Twitter: http://twitter.com/fcambus
+
+## Resources
+
+Project Homepage : http://www.statdns.com
+
+Latest tarball release : http://www.statdns.com/rrda/rrda-1.01.tar.gz
+
+GitHub : https://github.com/fcambus/rrda
