docs: update docs for BLOCK_LIST

jasonraimondi · Jul 13, 2024 · 9dbdb40 · 9dbdb40
1 parent 250efc6
commit 9dbdb40
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/.env.sample b/.env.sample
@@ -10,7 +10,7 @@ NODE_ENV=development
 # Comma-separated list of allowed domains for screenshots (optional)
 #ALLOW_LIST=jasonraimondi.com,github.com
 
-# Comma-separated list of allowed domains for screenshots (optional)
+# Comma-separated list of restricted domains for screenshots (optional)
 # BLOCK_LIST=example.com
 
 # Cache-Control header value for the responses (optional)

diff --git a/docs/config/index.md b/docs/config/index.md
@@ -9,9 +9,10 @@ Configure various settings through environment variables.
 - `PORT`: Port number for the application to listen on. Default: `3089`.
 - `CACHE_CONTROL`: Cache-Control header value for the responses. Default: `"public, max-age=86400, immutable"`.
 
-## Allow List
+## AllowBlock List
 
-- `ALLOW_LIST`: Comma-separated list of allowed domains for screenshots. If undefined or empty, all domains are allowed. Example: `ALLOW_LIST=jasonraimondi.com,github.com`.
+- `ALLOW_LIST`: Comma-separated list of **allowed** domains for screenshots. If undefined or empty, all domains are allowed. Example: `ALLOW_LIST=jasonraimondi.com,github.com`.
+- `BLOCK_LIST`: Comma-separated list of **restricted** domains for screenshots. If undefined or empty, all domains are allowed. Example: `BLOCK_LIST=localhost,google.com`.
 
 ## Playwright Options