docs: add Apache-2.0 NOTICE and align tool naming to Broadcast SSH#210
Merged
Conversation
Add a NOTICE file as recommended by Apache License 2.0 section 4(d). It records bssh's own copyright and attributes the two vendored upstream forks whose source we redistribute in-tree: russh (crates/bssh-russh, originally Thrussh by Pierre-Étienne Meunier, maintained by Eugeny Pankov) and russh-sftp (crates/bssh-russh-sftp, by AspectUnk), both Apache-2.0. Neither upstream ships a NOTICE file, so there is nothing to propagate; this attribution is for the vendored copies and the bssh-specific patches noted per crate. Extend the LICENSE copyright span to 2024-2026 to match active maintenance. Unify the auxiliary binaries with the v0.6.1 rebrand: bssh-server and bssh-keygen still surfaced "Backend.AI SSH" in their --help/version output while the main bssh CLI already said "Broadcast SSH". Switch both to "Broadcast SSH" so all tools are consistent. ARCHITECTURE.md keeps both names as "Broadcast SSH / Backend.AI SSH" to preserve the Backend.AI lineage in the design doc.
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
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
Adds an Apache-2.0
NOTICEfile and aligns the auxiliary binaries with the existing "Broadcast SSH" branding.russh(crates/bssh-russh, originally Thrussh by Pierre-Étienne Meunier, maintained by Eugeny Pankov) andrussh-sftp(crates/bssh-russh-sftp, by AspectUnk), both Apache-2.0. Neither upstream ships a NOTICE file, so there is nothing to propagate under section 4(d); this attribution covers the vendored copies and the bssh-specific patches noted per crate.2024-2026to match active maintenance.bssh-serverandbssh-keygenstill surfaced "Backend.AI SSH" in their--help/versionoutput, while the mainbsshCLI already said "Broadcast SSH" since the v0.6.1 rebrand. Both are switched to "Broadcast SSH" so all tools are consistent.Tests
cargo build --binspasses.bssh --help,bssh-server --help, andbssh-server versionall show "Broadcast SSH".Risk
Low. Changes are limited to documentation, license metadata, and user-facing help/version strings; no functional or logic changes.