Skip to content

docs: add Apache-2.0 NOTICE and align tool naming to Broadcast SSH - #210

Merged
inureyes merged 1 commit into
mainfrom
docs/notice-and-naming-cleanup
Jun 12, 2026
Merged

docs: add Apache-2.0 NOTICE and align tool naming to Broadcast SSH#210
inureyes merged 1 commit into
mainfrom
docs/notice-and-naming-cleanup

Conversation

@inureyes

Copy link
Copy Markdown
Member

Summary

Adds an Apache-2.0 NOTICE file and aligns the auxiliary binaries with the existing "Broadcast SSH" branding.

  • NOTICE (new): Records bssh's own copyright and attributes the two vendored upstream forks whose source is redistributed 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 under section 4(d); this attribution covers the vendored copies and the bssh-specific patches noted per crate.
  • LICENSE: Extends the copyright span to 2024-2026 to match active maintenance.
  • Naming cleanup: bssh-server and bssh-keygen still surfaced "Backend.AI SSH" in their --help/version output, while the main bssh CLI already said "Broadcast SSH" since the v0.6.1 rebrand. Both are switched 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.

Tests

  • cargo build --bins passes.
  • Verified rendered output: bssh --help, bssh-server --help, and bssh-server version all show "Broadcast SSH".
  • Pre-commit hook (cargo fmt + clippy) passed.

Risk

Low. Changes are limited to documentation, license metadata, and user-facing help/version strings; no functional or logic changes.

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.
@inureyes inureyes added type:docs Improvements or additions to documentation status:review Under review labels Jun 12, 2026
@inureyes
inureyes merged commit 9032638 into main Jun 12, 2026
3 checks passed
@inureyes
inureyes deleted the docs/notice-and-naming-cleanup branch June 12, 2026 16:22
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.
@inureyes inureyes self-assigned this Aug 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status:review Under review type:docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant