From 4b3b3c4a1c3a256319e08ec268da48a739f0428f Mon Sep 17 00:00:00 2001 From: adinhodovic Date: Thu, 14 Dec 2023 18:21:04 +0100 Subject: [PATCH] docs: Add description to readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83d76b7..73f330d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Terraform-Cloudflare-Maintenance -Terraform module to create a responsive **Maintenance Page** using -Cloudflare Workers. +Terraform module to create a responsive **Maintenance Page** using Cloudflare Workers. + +The Cloudflare script intercepts all incoming requests and checks if the request is coming from an IP that is in the whitelist or if the request path matches a whitelisted path. If the request is not whitelisted, it returns a maintenance page. The module can be used through [Terraform's registry](https://registry.terraform.io/modules/adinhodovic/maintenance/cloudflare/latest).