diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d6b57d --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# EnPLS EPEE Service + +This service serves as an error and debug service for the EnPLS Proxy infrastructure called EPEE for _Enpls Proxy EnginE_. This service is based on Traefik instances. + +EPEE Service provides : +- Error pages (Upstream error and not found page) on ``/error.html`` +- Static file serving as Traefik is unable to do that +- Debug utility at the ``/trace`` URL + +All of theses URL is prefixed by ``/cdn-cgi/`` and should be configured to be present on all proxied domain by Traefik. +