Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(backup): say the local media dir is archived under S3 storage

Yudhi Armyndharis7e87004347c0
diff --git a/docs/11-operational-runbooks.md b/docs/11-operational-runbooks.md
index 7ff55bfb4..d6cbfbd1d 100644
--- a/docs/11-operational-runbooks.md
+++ b/docs/11-operational-runbooks.md
@@ -584,7 +584,9 @@ User-managed files outside that list (for example the project-level `.env`) must
# or a pg_dump when DATABASE_TYPE=postgres)
# - sessions/ — whatsapp-web.js state (SESSION_DATA_PATH)
# - baileys/ — Baileys credentials (BAILEYS_AUTH_DIR)
-# - media/ — local media (skipped automatically when STORAGE_TYPE=s3)
+# - media/ — local media (STORAGE_LOCAL_PATH, archived whenever present; with
+# STORAGE_TYPE=s3 it holds only files the app could not
+# write to the bucket, so back up the bucket separately)
# - plugin-packages/ — installed plugin code from PLUGINS_DIR
# - plugin-state/ — registry + ctx.storage state under OPENWA_DATA_DIR
# - .env.generated / .api-key — generated configuration and bootstrap secret
diff --git a/scripts/backup.sh b/scripts/backup.sh
index b63ca194f..db77d9b35 100755
--- a/scripts/backup.sh
+++ b/scripts/backup.sh
@@ -7,7 +7,10 @@
# - data store — openwa.sqlite (SQLite) OR a pg_dump (when DATABASE_TYPE=postgres)
# - sessions/ — whatsapp-web.js LocalAuth session data
# - baileys/ — Baileys engine authentication state
-# - media/ — locally-stored media (skipped automatically when using S3)
+# - media/ — the local media dir (STORAGE_LOCAL_PATH), archived whenever it exists. Under
+# STORAGE_TYPE=s3 it holds only media the app could not write to the bucket
+# (unreachable, or no credentials); the bucket's contents are not archived and
+# need a backup of their own
# - plugin-packages/ — installed plugin packages from PLUGINS_DIR
# - plugin-state/ — registry and persisted ctx.storage state under OPENWA_DATA_DIR
# - .env.generated and .api-key — dashboard config and plaintext bootstrap admin key