Files
orbithub/docs/PROGRESS.md
T
ksmithandClaude Sonnet 5 8e98c208c9 Bump version to v2026.9.8.3
Same-day patch release: adds the in-app User Guide and standalone
User Guide PDF.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-08 18:31:50 -06:00

11 KiB

OrbitHub Progress

Milestone 0 - Restart in C++/Qt Widgets

Status: Completed

Delivered:

  • Fresh C++17/Qt6 Widgets scaffold with CMake
  • ProfilesWindow (QMainWindow) with search, profile list, and New/Edit/Delete controls
  • Double-click in Profiles opens a SessionWindow
  • SessionWindow (QMainWindow) with QTabWidget
  • Placeholder tab content showing OrbitHub Native Surface
  • main.cpp wiring for application startup
  • Cross-platform build command guide in docs/BUILDING.md

Git:

  • Tag: v0-m0-done

Milestone 1 - Storage and CRUD

Status: Completed

Delivered:

  • SQLite integration via Qt SQL (QSQLITE)
  • Persistent profile database bootstrap (profiles table)
  • Profiles CRUD (New / Edit / Delete) in ProfilesWindow
  • Search-backed profile listing from storage
  • Double-click connect opens SessionWindow tab with selected profile name

Git:

  • Tag: v0-m1-done

Milestone 2 - Profile Details and Connect Lifecycle

Status: Completed

Delivered:

  • SQLite schema migration for profile details (host, port, username, protocol, auth_mode)
  • New ProfileDialog form for New/Edit profile workflows
  • Profiles list now shows endpoint metadata and supports search by name or host
  • Connect now loads complete profile details into SessionWindow
  • Session tab lifecycle status updates (Connecting, Connected, Failed) via non-blocking timer flow

Git:

  • Tag: v0-m2-done

Milestone 3 - Real SSH Backend and Session Controls

Status: Completed

Delivered:

  • Backend architecture introduced (SessionBackend + protocol-specific implementations)
  • Worker-thread backend execution for connection lifecycle operations
  • Real SSH process backend (ssh) with connect/disconnect/reconnect
  • Unsupported protocol backend with explicit not-implemented messaging (RDP/VNC)
  • Session tab controls: Connect, Disconnect, Reconnect, Copy Error
  • Connect-time credential flow (password prompt / private-key path selection)
  • Session event log pane with timestamps and user-friendly error mapping
  • SQLite profile schema migration for private_key_path and known_hosts_policy

Git:

  • Tag: v0-m3-done

Milestone 4 - Interactive SSH Session UX

Status: Completed

Delivered:

  • Embedded interactive SSH terminal using KodoTerm + vendored libvterm
  • Native in-terminal typing for SSH sessions (no separate input box)
  • ANSI/color rendering with selectable terminal themes (Dark, Light, Solarized Dark)
  • Cross-platform SSH auth path improvements (ssh-askpass handling and host-key policy wiring)
  • Session UX simplification: auto-connect on tab open, disconnect on tab close
  • Tab-state indicators via tab color and state suffix (Connecting, Connected, Disconnected, Failed)
  • Right-click tab menu for Disconnect, Reconnect, Theme, and Clear
  • Collapsible events panel retained as primary diagnostics surface; inline detail/status banners removed
  • Terminal behavior polish: better fixed-width font selection, cursor visibility, backspace handling, and terminal-size negotiation stability

Git:

  • Tag: v0-m4-done

Milestone 5 - RDP Fully Working

Status: Completed

Delivered:

  • Added RdpSessionBackend and wired protocol selection so RDP no longer routes to unsupported backend
  • Pivoted RDP design to embedded-only integration (no external RDP process launches)
  • Implemented embedded FreeRDP client thread with connect/disconnect lifecycle and event-loop handling
  • Added in-window RdpDisplayWidget rendering surface with frame updates from FreeRDP GDI
  • Wired direct keyboard/mouse input from the embedded RDP surface to the backend
  • Added RDP connect-time password prompt flow and settings wiring (host/port/user/password, desktop size)
  • Added explicit profile Domain support for RDP auth (with DOMAIN\username fallback parsing)
  • Updated session tab/context-menu behavior so terminal-only actions are hidden on RDP tabs
  • Implemented dynamic in-session RDP resolution renegotiation from viewport resize events
  • Enabled minimal FreeRDP client-channel build (drdynvc + disp) and channel loading for runtime resize support
  • Added RDP profile-level security mode and performance profile options, wired into FreeRDP connection settings
  • Hardened RDP lifecycle handling for disconnect/reconnect/abort flows to avoid false failure states on user-initiated stops
  • Expanded RDP error/disconnect diagnostics with richer FreeRDP code mapping and raw disconnect detail events
  • Pulled FreeRDP source for integration planning and API review

Git:

  • Tag: v0-m5-done

Milestone 6 - VNC Fully Working

Status: Deferred (temporarily postponed)

Planned Scope:

  • Replace current unsupported VNC path with complete VNC implementation
  • Deliver usable in-app VNC session behavior aligned to SSH/RDP UX
  • Implement VNC connect/disconnect/reconnect lifecycle handling
  • Extend profile/session connect options needed by VNC
  • Standardize event log and error mapping behavior with SSH/RDP

Milestone 7 - Cross-Platform Protocol Hardening

Status: Completed

Delivered:

  • Validated SSH and RDP workflows on Linux, macOS, and Windows 11 (VNC is out of scope while Milestone 6 remains deferred)
  • Windows: validated the full docs/BUILDING.md toolchain end-to-end (Git/CMake/Ninja/VS Build Tools with the C++ workload/vcpkg for Qt6-OpenSSL-zlib); documented a VS Build Tools installer gotcha where the actual compiler is a "recommended", not "required", component of the VCTools workload
  • Fixed RDP keyboard input misreading punctuation keys on Linux (X11 keycode numbering was being treated as a PC/AT scancode; now uses FreeRDP's authoritative X11-keycode-to-scancode table)
  • Added RDP clipboard sync (bidirectional, plain text) and RDP cursor/pointer shape sync (resize handles, text I-beam, etc. instead of a static arrow)
  • Fixed Tab/Shift+Tab being intercepted by local UI focus navigation instead of reaching SSH/RDP sessions
  • Fixed RDP key auto-repeat being dropped, so holding a key only ever sent a single keystroke to the remote machine
  • Windows-specific RDP fixes: a crash on every connect attempt (FreeRDP's signal-handling critical section was never initialized) and a host resolution failure on every connect, including literal IP addresses (Winsock was never initialized via WSAStartup)
  • Windows: automatic build-time deployment of Qt's platform/SQL-driver plugins and their runtime DLL dependencies, and marked the executable as a GUI (WIN32) app to remove a stray console window behind the UI
  • Windows and macOS: proper native app icon embedding (Windows .rc/.ico resource; macOS .app bundle with .icns), replacing the generic default icon previously shown for the built executable/bundle
  • macOS: fixed Edit/New Profile dialog form fields collapsing to sizeHint width due to the platform-default QFormLayout field growth policy

Git:

  • Tag: Pending user approval (v0-m7-done)

Milestone 8 - Profile and Session UX Completion

Status: Completed

Delivered:

  • Added profile tags field to storage + schema migration and profile editor UX
  • Added profile folder_path field + nested folder/subfolder profile view mode
  • Added profile tree context actions (New Folder, New Connection) and drag-to-folder profile moves with persistence
  • Added Help -> About OrbitHub dialog with third-party library inventory and MIT/Apache-2.0 license links
  • Extended profile search to include tags/folder path and added profile sort controls (Name, Protocol, Host)
  • Persisted profile list UX preferences (search text, view mode, protocol/tag filters, sort order) across app restarts
  • Added protocol-aware profile validation/normalization for SSH/RDP/VNC (repository + dialog)
  • Improved profile form protocol UX hints and SSH private-key path validation
  • Added session events filtering and tab-context actions (Show/Hide Events, Copy Events, Clear Events)
  • Added session diagnostics QoL: severity quick-filter (All/Warnings/Errors) and Export Events action
  • Persisted session UI defaults (terminal theme, events panel visibility) for new tabs/windows
  • Added profile quick filters (Protocol, Tag) with persistence to speed profile browsing

Validation:

  • Local build verification passed (cmake --build build)
  • No automated tests are currently configured in CTest

Git:

  • Tag: Pending user approval (v0-m8-done)

Milestone 9 - Packaging and Distribution

Status: Completed

Delivered:

  • Linux .deb (packaging/linux/build-deb.sh) and Flatpak (packaging/flatpak/build-flatpak.sh) packages, both verified installed and launched with working SSH/RDP
  • Renamed the app's reverse-DNS identity from io.orbithub.OrbitHub to org.darksingularity.OrbitHub (desktop file, AppStream metainfo, Flatpak manifest, macOS bundle identifier) to reflect a domain actually owned by the project
  • Fixed Linux taskbar/panel pin matching (StartupWMClass) so a pinned launcher merges with its running window instead of creating a duplicate entry
  • Replaced the stale, mismatched hand-authored launcher SVG with PNG icons rendered directly from the app's own createOrbitHubAppIcon() at each hicolor theme size
  • Windows installer via Inno Setup (packaging/windows/orbithub.iss, packaging/windows/build-installer.ps1), verified installed silently and launched cleanly with no crash events
  • macOS .dmg via cmake --install + macdeployqt + hdiutil (packaging/macos/build-dmg.sh), verified installed and launched after fixing:
    • a launch crash caused by macdeployqt invalidating the code signature (fixed with ad hoc re-signing)
    • a missing-library crash caused by the Linux-only $ORIGIN rpath token and vendored dylibs installing outside the .app bundle (fixed with APPLE-specific @executable_path/Contents/Frameworks layout)
    • the dmg showing the generic disk icon instead of the app icon
  • README and docs/BUILDING.md Packaging sections documented for all three platforms

Validation:

  • All three installers built, installed, and launched successfully with working SSH/RDP sessions
  • Code signing is ad hoc only (no purchased Apple Developer ID or Windows code-signing certificate), so macOS Gatekeeper and Windows SmartScreen still show first-run warnings by design

Git:

  • Tag: v0-m9-done
  • Release: v2026.9.8 (v2026.9.8 tag, installers for Windows/Linux/macOS)
  • Release: v2026.9.8.2 — same-day patch fixing RDP TLS certificate verification (was fully disabled) and preparing Flatpak packaging for Flathub submission
  • Release: v2026.9.8.3 — same-day patch adding an in-app User Guide and standalone User Guide PDF

Milestone 10 - v1.0 Stabilization

Status: Planned

Planned Scope:

  • Run final regression and acceptance testing across all protocols
  • Resolve release-blocking defects
  • Finalize docs and publish v1.0 release notes/checklist