diff --git a/README.md b/README.md new file mode 100644 index 0000000..e30622d --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +RPKI ROA Sanity Checker + +This Python app checks the information for a proposed RPKI-ROA, provided by the user via a web form, against exiting routes seen on the Internet and reported by RIPEstat. The response will include a row for the route matching the proposed ROA's prefix, and additional rows for any more specific routes seen on the Internet. + +Each row contains four columns: + +1. The prefix being evaluated. +2. The result of the proposed ROA applied to the prefix. +3. The origin ASN seen via RIPEstat for the prefix. +4. The status of any existing ROA that covers this prefix. + +The app is designed to be invoked as a docker command: +``` +docker run -dp 8000:8000 stevenisfine/roa_checker:latest +``` + +