Skip to content

Conversation

@zach-is-my-name
Copy link

@zach-is-my-name zach-is-my-name commented Aug 21, 2025

Main Changes:

  1. Added "Required Configuration" section - Shows the complete wrangler.json structure needed for local development
  2. Clarified required fields:
    - name field in container config
    - instance_type field (typically "standard")
    - nodejs_compat compatibility flag
  3. Added troubleshooting note - Explains that missing these fields causes "Connection refused" errors
  4. Removed misleading phrase - Changed "without additional configuration" to just describing how to run the commands

The updated documentation now accurately reflects what's actually needed to get containers working locally,
preventing the issues we encountered. This should help other developers avoid the debugging session we just
went through!

Credit to https://github.com/megaconfidence/wifski/tree/main for providing the correct pattern.

Summary

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

  Main Changes:

  1. Added "Required Configuration" section - Shows the complete wrangler.json structure needed for local
  development
  2. Clarified required fields:
    - name field in container config
    - instance_type field (typically "standard")
    - nodejs_compat compatibility flag
  3. Added troubleshooting note - Explains that missing these fields causes "Connection refused" errors
  4. Removed misleading phrase - Changed "without additional configuration" to just describing how to run the
  commands

  The updated documentation now accurately reflects what's actually needed to get containers working locally,
  preventing the issues we encountered. This should help other developers avoid the debugging session we just
  went through!
@zach-is-my-name zach-is-my-name requested review from a team, mikenomitch and th0m as code owners August 21, 2025 13:40
@zach-is-my-name zach-is-my-name changed the title Update local-dev.mdx [containers] Update local-dev.mdx Aug 21, 2025
Copy link
Contributor

@emily-shen emily-shen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instance_type and name, and the node_compat flag aren't required in local dev (or production) - i've just tested it out without those fields, and not had any issues. maybe you're hitting a bug? D: are you able to create a repro and open an issue in workers-sdk?

@zach-is-my-name
Copy link
Author

zach-is-my-name commented Aug 21, 2025 via email

@emily-shen emily-shen closed this Aug 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants