Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(env): say invalid storage and plugin caps fail the boot

Yudhi Armyndharis9e77f7da6ac5
diff --git a/.env.example b/.env.example
index 718a29d6f..3f06063f8 100644
--- a/.env.example
+++ b/.env.example
@@ -295,7 +295,7 @@ OPENWA_PIDS_LIMIT=2048
# BAILEYS_CHAT_STATE_CACHE_MAX=5000
# Per-session cap on the Baileys message rows kept in the database: the newest N survive and older
-# rows are pruned after each write. A non-positive or non-numeric value falls back to the default.
+# rows are pruned after each write. A value that is not a positive integer fails the boot.
# BAILEYS_MESSAGE_STORE_LIMIT=5000
# Observability — Prometheus scrape endpoint at GET /api/metrics.
@@ -408,8 +408,8 @@ DATABASE_SYNCHRONIZE=false # WARNING: Set false in production! (data DB
# STORAGE_LOCAL_PATH=./data/media
# Cap on how many files one local-storage listing call enumerates, so a large media directory cannot
-# be walked into memory in a single request. A non-positive or non-numeric value falls back to the
-# default. Streaming reads are not affected — only the listing call is truncated.
+# be walked into memory in a single request. A value that is not a positive integer fails the boot.
+# Streaming reads are not affected — only the listing call is truncated.
# STORAGE_LIST_MAX_FILES=100000
# S3/MinIO settings (if STORAGE_TYPE=s3). Saving storage from the dashboard writes the credentials
@@ -650,7 +650,8 @@ WEBHOOK_SSRF_PROTECT=true
# CHAT_MEDIA_ORPHAN_SWEEP_INTERVAL_MS=3600000 # default 1h
# CHAT_MEDIA_ORPHAN_GRACE_MS=3600000 # default 1h
# Cap on the final rendered text of a send-template request (after variable substitution). Over-cap
-# renders are rejected with 400, never silently truncated. A non-positive/garbage value falls back.
+# renders are rejected with 400, never silently truncated. A value that is not a positive integer
+# fails the boot.
# TEMPLATE_RENDER_MAX_CHARS=65536 # default 64 KiB
# Cap on concurrently-running bulk batches (POST .../messages/send-bulk). 0 = unlimited. A non-finite
# or negative value falls back to the default.
@@ -850,18 +851,18 @@ PLUGINS_DIR=./data/plugins # Plugin directory (default: ./data/plugins)
# on the default layout `<old root>/plugins` IS PLUGINS_DIR, and moving it would take the installed
# packages away from the loader.
# PLUGIN_STATE_DIR=./data
-# Cap on a plugin .zip downloaded by install-from-URL (matches the 5 MB upload limit). A non-positive
-# or non-numeric value falls back to the default.
+# Cap on a plugin .zip downloaded by install-from-URL (matches the 5 MB upload limit). A value that
+# is not a positive integer fails the boot.
# PLUGIN_DOWNLOAD_MAX_BYTES=5242880 # default 5 MiB
# Require a #sha256=<hex> integrity pin on EVERY plugin install from a URL (production default;
# https alone authenticates the channel, not the bytes-as-reviewed). false lifts the requirement.
# PLUGIN_INSTALL_REQUIRE_PIN=true
# Host-side budget for one sandboxed plugin capability call; a wedged call is failed and its in-flight
-# slot freed (the late-settling work is only logged, not cancelled). A non-positive or non-numeric
-# value falls back to the default.
+# slot freed (the late-settling work is only logged, not cancelled). A value that is not a positive
+# integer, or above 536870911 ms (send verbs wait four times it), fails the boot.
# PLUGIN_CAP_TIMEOUT_MS=30000 # default 30s
-# Per-plugin bound on ctx.storage writes; writes beyond it are rejected. A non-positive or non-numeric
-# value falls back to the default.
+# Per-plugin bound on ctx.storage writes; writes beyond it are rejected. A value that is not a positive
+# integer fails the boot.
# PLUGIN_STORAGE_MAX_BYTES=52428800 # default 50 MiB
# Allow an https plugin-download URL to redirect to a plain-http hop (default: refused — the package
# is executable code and an http hop exposes it to on-path substitution). Enable only if your vendor