FAQ: wpfy debug — what to include when asking for help

[arnab]

How to use wpfy debug and what to include when asking for help. See Operations.

What wpfy debug does

wpfy debug runs structured checks across:

• Docker Engine and Compose plugin
• The Traefik edge proxy
• Every managed site (runtime, scaffold, HTTP readiness)
• Certificate state where relevant

It returns structured facts — not raw command dumps — so the output is safe to share once secrets are redacted.

Run it

wpfy debug

For a specific site:

wpfy site status example.com
wpfy site info example.com

What to post when asking for help

1. The exact command you ran.
2. What you expected vs. what happened.
3. The wpfy debug output, redacted:

   $ wpfy debug
   [ paste here, replace any password/token/key with <redacted> ]
   

4. OS and Docker version:

   $ docker --version
   $ lsb_release -a
   

5. A redacted .env if the issue is site-specific.

See How to ask a good wpfy support question for the full template.

Other useful commands

• wpfy info — aggregate host + site operational facts
• wpfy log example.com — per-site log inspection
• wpfy secure — security audit baseline
• wpfy maintenance — maintenance mode controls

Common fixes

• Site not reachable: wpfy debug → check Traefik + site runtime checks → wpfy site status example.com.
• SSL failed: DNS/IP preflight — see the SSL FAQ.
• Restore failed: the archive must validate before the runtime stops. wpfy debug after a failed restore to confirm state.

Never paste

• Database passwords (MariaDB, Redis)
• API tokens
• Anything from .env (redact the whole file)
• SSH private keys
• ACME account keys