From 9b233b017158ab987a711c6d047ef832dbd816fc Mon Sep 17 00:00:00 2001 From: nickfelt Date: Tue, 18 Oct 2016 07:40:57 -0700 Subject: [PATCH] Update README.md "Known issues" section This seems like a better description of the actual contents of the section. Expanded contents to mention the need for fully automated reporting and for crypto key storage. Also reshuffled the list a bit to put the things likely to be top concerns first. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=136471298 --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2214bc59c..9c9953640 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,10 @@ Nomulus has the following capabilities: ## Known issues -Here are some additional things you will likely need or want that are not -provided out of the box: +Registry operators interested in deploying Nomulus will likely require some +additional components that are not provided out of the box. + +**Core dependencies** * A DNS system. An interface for DNS operations is provided so you can write an implementation for your chosen provider, along with a sample @@ -96,13 +98,23 @@ provided out of the box: capabilities and provide your own multi-[AS](https://en.wikipedia.org/wiki/Autonomous_system_\(Internet\)) solution. -* An invoicing/payments system in order to charge registrars for domain name - registrations and accept payments. -* System status and uptime monitoring. * A proxy to forward traffic on EPP and WHOIS ports to App Engine via HTTPS, since App Engine Standard only serves HTTP/S traffic. The proxy must support IPv4 and IPv6 access to comply with ICANN's requirements for gTLDs. +**Additional functionality** + +* An invoicing/payments system in order to charge registrars for domain name + registrations and accept payments. +* Fully automated reporting to meet ICANN's requirements for gTLDs. Nomulus + includes substantial reporting functionality but some additional work will + be required by the operator in this area. +* A secure method for storing cryptographic keys. A keyring interface is + provided for plugging in your own implementation (see [configuration doc]( + https://github.com/google/nomulus/blob/master/docs/configuration.md) for + details). +* System status and uptime monitoring. + ## Outside references * [Donuts](http://donuts.domains) Registry has helped review the code and