From 7ef515d7d54218d0bec2932a82e9348f6ac649a7 Mon Sep 17 00:00:00 2001 From: "Mathias V. Nielsen" <1547127+math280h@users.noreply.github.com> Date: Thu, 10 Nov 2022 21:03:17 -0500 Subject: [PATCH] Updated documentation --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 032d0d2..ea497a2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # terraform-kubernetes-traefik-middleware A simple collection of easy to use middlewares for traefik implemented in terraform. + +## Middlewares +When using this module, the following middlewares will be created - Keep in mind you must still apply them to the routes you want them on. + +| Name | Description | +|---|---| +| default-headers | Applies headers to all requests | +| forward-authentication | Allows you to forward a request for authentication before proxying | +| ip-whitelist | Simple IP Whitelist | +| rate-limit | Simple Rate Limit on HTTP Requests | +| redirect-regex | Allows you to redirect requests based on regex pattern | +| redirect-https | Automatically redirects requests to https |