chore: Update README

This commit updates the README to include the findings in #137, because it is useful to have this information directly in the README rather than having to search for it.
corazawaf · Aug 2, 2024 · 59a591a · 59a591a
1 parent 75d8677
commit 59a591a
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -125,3 +125,27 @@ go run mage.go buildCaddy
 # in terminal 3
 curl -i localhost:8080/
 ```
+
+## Respond with custom message or HTML page
+
+In order to respond with a custom message or HTML page, you can take advantage of [handle_errors](https://caddyserver.com/docs/caddyfile/directives/handle_errors) directive:
+
+```caddy
+handle_errors 403 {
+ header X-Blocked "true"
+ respond "Your request was blocked. Request ID: {http.request.header.x-request-id}"
+}
+```
+or
+```caddy
+handle_errors {
+ @block_codes `{err.status_code} in [403]`
+ handle @block_codes {
+  root    * /path/to/html/dir
+  rewrite * /{err.status_code}.html
+  file_server
+ }
+}
+```
+
+It is possible to use the [templates](https://caddyserver.com/docs/caddyfile/directives/templates) directive to render data dynamically. Take a look at [`example/403.html`](./example/403.html) file.  
diff --git a/example/403.html b/example/403.html
@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Access Denied</title>
+    <style>
+      body {
+        display: flex;
+        justify-content: center;
+        align-items: center;
+        height: 100vh;
+        margin: 0;
+        font-family: 'Arial', sans-serif;
+        background-color: #328ba8;
+        color: #ffffff;
+      }
+
+      .access-denied-container {
+        text-align: center;
+        padding: 50px;
+        border-radius: 10px;
+        background: rgba(0, 0, 0, 0.7);
+      }
+
+      h1 {
+        font-size: 5em;
+        margin: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="access-denied-container">
+      <h1>Access Denied</h1>
+      <p>Host: {{.Host | stripHTML}}</p>
+    </div>
+  </body>
+</html>
diff --git a/example/Caddyfile b/example/Caddyfile
@@ -26,5 +26,14 @@
 		SecRule RESPONSE_BODY "@contains responsebodycode" "id:104,phase:4,t:lowercase,deny,status:403"
 		`
 	}
+
+    handle_errors 403 {
+        header X-Blocked "true"
+        root    * /etc/caddy/custom-pages
+        rewrite * /{err.status_code}.html
+        file_server
+        templates
+    }
+
 	reverse_proxy {$HTTPBIN_HOST:localhost}:8081
 }
diff --git a/example/docker-compose.yml b/example/docker-compose.yml
@@ -24,6 +24,7 @@ services:
       dockerfile: ./example/Dockerfile
     volumes:
       - logs:/home/caddy/logs:rw
+      - ./403.html:/etc/caddy/custom-pages/403.html:ro
     ports:
       - 8080:8080
     environment: