Skip to content

docs: Add Windows WSL2 IPv6 troubleshooting guidance - #317

Open
loaj84 wants to merge 1 commit into
mainfrom
la.win-local-readme-update
Open

docs: Add Windows WSL2 IPv6 troubleshooting guidance#317
loaj84 wants to merge 1 commit into
mainfrom
la.win-local-readme-update

Conversation

@loaj84

@loaj84 loaj84 commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Description

Adds concise Windows/WSL2 IPv6 troubleshooting guidance for local deployments.

Type of Change

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation update
  • test: Test additions or changes
  • refactor: Code refactoring
  • chore: Maintenance tasks

Changes Made

  • Added Windows/WSL2 SSH IPv6 troubleshooting guidance to README.md.
  • Documented forcing Podman SSH connections to IPv4 with AddressFamily inet.

Testing

  • All existing tests pass (task all)
  • Added new tests for new functionality
  • Manually tested the changes

Checklist

  • Code follows the project's coding guidelines
  • Ran task fmt and task lint
  • Updated documentation (if applicable)
  • Updated CHANGELOG.md for user-facing changes, including examples for new features when useful
  • Added/updated tests
  • All tests pass locally
  • Commit messages follow Conventional Commits format

@loaj84
loaj84 requested review from a team and moben September 1, 2026 12:12
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-01T12:15:46.010697Z 5d70177 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5d70177238

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +268 to +270
### Windows/WSL2 IPv6 troubleshooting

If a Windows local deployment fails with SSH connection resets or timeouts, force Podman’s SSH connection to use IPv4. Add this to `%USERPROFILE%\.ssh\config`:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Record the troubleshooting guidance in the changelog

Because this addition instructs Windows users to change their SSH configuration to operate or troubleshoot local deployments, it meets the explicit changelog threshold in CONTRIBUTING.md:36 for documentation that changes how users operate the tool. Add a corresponding entry under CHANGELOG.md’s Unreleased section so the workaround is included in the user-facing release history.

AGENTS.md reference: AGENTS.md:L11-L13

Useful? React with 👍 / 👎.

Comment thread README.md
Comment on lines +273 to +274
Host *
AddressFamily inet

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Scope the IPv4 override to Podman

For Windows users who also connect to IPv6-only SSH hosts, Host * applies AddressFamily inet to every SSH destination, not only Podman, so following this workaround breaks those unrelated connections. This can be confirmed with OpenSSH configuration expansion: ssh -G -F <config> example.com reports addressfamily inet for an arbitrary host with this stanza. Scope the override to Podman’s connection or explain that users must remove it after troubleshooting.

Useful? React with 👍 / 👎.

@sonarqubecloud

sonarqubecloud Bot commented Sep 1, 2026

Copy link
Copy Markdown

@moben moben left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Wait, this causes deployment failure? My understanding earlier was that this is about manual ssh. Do we do ssh anywhere?

Does podman run itself work in this setup? If yes, what actually fails?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants