Skip to content

Commit 95a8ecd

Browse files
committed
First version of README
1 parent 9f55e08 commit 95a8ecd

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# [Red Dog](https://www.reddog.mx/)
2+
3+
Red Dog is an Open Source RDAP (Registration Data Access Protocol) Server implementation built with Java, funded and developed by [NIC Mexico](http://www.nic.mx).
4+
5+
The server is a RESTful service expected to provide HTTP content in accordance with:
6+
- [RFC 7480 - HTTP Usage in the Registration Data Access Protocol (RDAP)](https://tools.ietf.org/html/rfc7480)
7+
- [RFC 7481 - Security Services for the Registration Data Access Protocol (RDAP)](https://tools.ietf.org/html/rfc7481)
8+
- [RFC 7482 - Registration Data Access Protocol (RDAP) Query Format](https://tools.ietf.org/html/rfc7482)
9+
- [RFC 7483 - JSON Responses for the Registration Data Access Protocol (RDAP)](https://tools.ietf.org/html/rfc7483).
10+
11+
Beside the RFCs accordance, Red Dog has the following features:
12+
- Response render can be customized by implementing a set of interfaces; e.g. beside JSON responses, a TEXT/HTML/XML or any other response type can be returned if the implementer wishes to.
13+
- Reference database and data access implementation to ease Red Dog's use.
14+
- A set of Java interfaces to implement any kind of data access according to the implementer needs (e.g. data can be obtained from the implementer data repository).
15+
- Optional Basic Authentication and the possibility to implement/customize the authentication type if needed.
16+
- Response data privacy using general settings (e.g. everybody can see X data, nobody can see Y data, etc.) or specific settings (e.g. only the owner can see X data, certain custom user roles can see Y data).
17+
18+
## Documentation
19+
20+
The documentation can be seen [here](https://www.reddog.mx/documentation.html).
21+
22+
## Contact
23+
24+
Any comment or feedback is welcomed, issues can be reported at Red Dog's [Github corner](https://github.com/NICMx/rdap-server).
25+
26+
Visit our [contact page](https://www.reddog.mx/contact.html) to get more information.
27+
28+
## License
29+
30+
Red Dog is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)