docs: state native Windows client support is not supported - #221
Merged
Conversation
The bssh crate does not build for a Windows target today: the top-level Cargo.toml declares nix, signal-hook, and libc unconditionally, and the PTY/agent/keygen code paths are un-gated for Unix, with no Windows CI or release target. Add an explicit "Platform Support" section to README.md that states native Windows client execution is not currently supported, recommends WSL2 as the path today, and links to #213 for the full blocker list. Update the existing "Cross-Platform" feature bullet to point at the new section, and extend the related note in docs/architecture/ssh-client.md so the SSH-agent-on-Windows caveat also cross-references the broader platform-support status and the issue. No code changes: the known blockers are already tracked in #213 itself, and native Windows support remains an optional, separately-scoped follow-up. Refs #213
inureyes
added
type:question
inureyes
added a commit
that referenced
this pull request
Jul 18, 2026
Bump version to 2.3.0 and finalize release documentation. - SFTP performance: roughly double single-connection write throughput on bssh-server via channel sizing, pipelined server writes, and a tuned release profile (#187, #224) - Fix the paramiko prefetch SFTP deadlock and enable TCP_NODELAY (#227) - Make sftp.root/scp.root chroot usable and confine symlink targets (#214) - Make server SSH compression configurable and wire the ssh_config Compression directive into the client (#215, #219, #220) - Drop the vendored bssh-russh fork for upstream russh 0.62.1 (#212) - Raise workspace MSRV to 1.93 with a CI guard; add NOTICE, Windows support docs, and the tools/bench SFTP harness (#210, #221, #228) Update Cargo.toml/Cargo.lock, README Recent Updates, CHANGELOG, debian/changelog, and the three man pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents that native Windows client execution is not currently supported, answering the inquiry in #213 without attempting the (explicitly out-of-scope) native Windows port itself.
What changed
README.md: adds a new "Platform Support" section stating that Linux and macOS are fully supported, native Windows client execution is not currently supported, and WSL2 is the recommended path today, linking to Native Windows client support: current status and blockers (not supported today; WSL2 recommended) #213 for the full blocker list; the existing "Cross-Platform" feature bullet now points at this section.docs/architecture/ssh-client.md: extends the existing "SSH agent not supported on Windows" note so it also cross-references the broader native-Windows-client status and links to the README section and Native Windows client support: current status and blockers (not supported today; WSL2 recommended) #213.nix/signal-hook/libcdependencies, un-gated PTY/agent/keygen code, no Windows CI/release target) are already captured in Native Windows client support: current status and blockers (not supported today; WSL2 recommended) #213 itself; native Windows support remains an optional, separately-scoped follow-up.Test plan
git diffreviewed to confirm only the two documentation files changed.Closes #213