diff --git a/README.md b/README.md index 40648e6..8e8a3ca 100755 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A browser extension for managing BitTorrent clients. Built with WXT, React, and [](https://github.com/StarlightDaemon/CTRL/releases) [](https://github.com/StarlightDaemon/CTRL/releases) [](https://github.com/StarlightDaemon/CTRL/actions/workflows/ci.yml) -[](extension/tests) +[](https://github.com/StarlightDaemon/CTRL/actions/workflows/ci.yml) [](LICENSE) --- @@ -36,14 +36,18 @@ A browser extension for managing BitTorrent clients. Built with WXT, React, and | Aria2 | ✅ Basic | RPC Multicall | | Synology | ✅ Full | 2FA, Device Token, NAS Integration | +This table is the public support matrix for implemented adapter types. Internal audit or stabilization priorities may temporarily focus on a subset of adapters without implying that the others were removed from the product. + --- ## 🚧 Project Status -**Current Status**: Beta / Active Development -**Target**: v1.0 Store Release (Coming 2026) +**Current Status**: Beta / Active Stabilization +**Target**: v1.0 Store Release + +This project is currently in **Beta**. Use [docs/BETA_TESTING.md](docs/BETA_TESTING.md) as the public source of truth for current beta status, tester guidance, and validation-scope notes. -This project is currently in **Beta**. We recommend most users wait for the official release on the Chrome Web Store and Firefox Add-ons site. +`ROADMAP.md` is strategic direction, not the live status page. --- @@ -62,9 +66,9 @@ This project is currently in **Beta**. We recommend most users wait for the offi | Document | Description | |----------|-------------| -| [Beta Guide](docs/BETA_TESTING.md) | **Start Here** - Installation & Testing | +| [Beta Guide](docs/BETA_TESTING.md) | **Start Here** - Public beta status, installation, and testing guidance | | [E2E Troubleshooting](docs/E2E_TROUBLESHOOTING.md) | Diagnose Playwright/Environment issues | -| [ROADMAP.md](ROADMAP.md) | Future features & strategy | +| [ROADMAP.md](ROADMAP.md) | Strategic direction, not live status | | [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) | Setup build environment | | [CONTRIBUTING.md](CONTRIBUTING.md) | Contribution guidelines | diff --git a/ROADMAP.md b/ROADMAP.md index 9ddb196..99a6f75 100755 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -2,6 +2,8 @@ > **Strategic direction for the CTRL browser extension** +Status note: This roadmap is strategic direction, not the public live-status page. Use [docs/BETA_TESTING.md](docs/BETA_TESTING.md) for the current beta-status and tester-facing state. + --- ## Vision @@ -17,7 +19,7 @@ Transform CTRL from a working port into a **Best-in-Class** torrent management s ### ✅ Current Baseline - **Phase 1: Beta Release** shipped in January 2026 -- **357 unit tests** currently pass in the maintained local/CI baseline +- **Maintained validation baseline** is documented in `docs/CI_BASELINE.md` - **Deterministic CI** is restored with tracked lockfile, `npm ci`, and npm caching - **Mainline rewrite and normalization** are complete - **Privacy Policy** and beta distribution remain in place @@ -64,7 +66,7 @@ Transform CTRL from a working port into a **Best-in-Class** torrent management s | Feature | Priority | Notes | |---------|----------|-------| -| VPN Integration Check | Medium | ⏳ Deferred to v0.4.x+ | +| VPN Integration Check | Medium | ⏳ Deferred to v0.4.x+; prototype archived | | Cloud Sync | Low | Encrypted settings sync | | Torrent Detail View | Low | Files, Peers, Trackers tabs | | RSS Auto-Downloader | Low | Regex filtering | @@ -99,4 +101,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for how to get involved. --- -*Last Updated: March 2026* +*Last Updated: April 2026* diff --git a/docs/BETA_TESTING.md b/docs/BETA_TESTING.md index fcc7303..3f00b97 100755 --- a/docs/BETA_TESTING.md +++ b/docs/BETA_TESTING.md @@ -6,6 +6,8 @@ **Release Date**: January 2026 **Status**: Public Beta Testing +Authority note: This document is the public source of truth for current beta status, tester guidance, and validation-scope notes. `README.md` is the overview page, and `ROADMAP.md` is strategic direction rather than live status. + --- ## What is CTRL? @@ -18,7 +20,7 @@ CTRL (Torrent Control) is a browser extension that provides a **unified interfac ### ✅ Fully Functional Features -#### Torrent Client Support (9 Clients) +#### Torrent Client Support (10 Clients) - ✅ **qBittorrent** - Full support with categories, tags, and sequential download - ✅ **Transmission** - Session management and directory support - ✅ **Deluge** - Multi-step authentication and label support @@ -28,9 +30,13 @@ CTRL (Torrent Control) is a browser extension that provides a **unified interfac - ✅ **BiglyBT** - Basic operations - ✅ **Vuze** - Basic operations - ✅ **Aria2** - JSON-RPC multicall support +- ✅ **Synology** - NAS integration with device-token and 2FA support + +This list mirrors the public adapter matrix in `README.md`. Internal audit or stabilization priorities may focus on a subset of adapters without changing the product-level support matrix shown here. #### Site Integrations -- ⛔ **Discontinued** - Use Context Menu (Right-Click) integration instead. +- ⛔ **Removed from CTRL** - Site-specific integrations were moved to a separate extension to keep CTRL focused and avoid a "kitchen sink" product scope. +- ✅ **Supported alternative in CTRL** - Use Context Menu (Right-Click) integration instead. #### Core Features @@ -49,11 +55,11 @@ CTRL (Torrent Control) is a browser extension that provides a **unified interfac ## ⚠️ Known Limitations ### Technical Debt -- **YTS.mx**: Planned integration via API/Context Menu. +- **No site-specific integrations in CTRL**: Site-integration work now belongs to the separate extension, not this repository's product scope. ### Not Implemented Yet -- **E2E Testing**: Playwright test infrastructure designed but not yet implemented +- **E2E Testing**: Playwright-based end-to-end tests exist under `./tests/e2e`. CI runs non-`@integration` tests only (`npm run test:e2e -- --grep-invert "@integration"`). Full E2E coverage is not yet claimed. - **Performance Optimization**: Diffing engine for large torrent lists (>5,000 torrents) not yet implemented - **Advanced i18n**: Build-time transformation pipeline planned @@ -70,7 +76,7 @@ CTRL (Torrent Control) is a browser extension that provides a **unified interfac ### Method 1: From GitHub Releases (Recommended) 1. **Download the Extension** - - Visit [Releases](https://github.com/YOUR_USERNAME/CTRL/releases) + - Visit [Releases](https://github.com/StarlightDaemon/CTRL/releases) - Download `ctrl-chrome-v0.2.0-beta.1.zip` (for Chrome/Edge) - OR download `ctrl-firefox-v0.2.0-beta.1.zip` (for Firefox) - Extract the ZIP file @@ -94,7 +100,7 @@ CTRL (Torrent Control) is a browser extension that provides a **unified interfac ```bash # Clone repository -git clone https://github.com/YOUR_USERNAME/CTRL.git +git clone https://github.com/StarlightDaemon/CTRL.git cd CTRL/extension # Install dependencies @@ -181,10 +187,10 @@ npm run build:firefox - Report any authentication issues - Verify torrent operations work (add, pause, resume, remove) -2. **Site Integration Stability** - - Test on different torrent sites - - Report if buttons don't appear - - Check for layout conflicts or broken pages +2. **Context Menu Reliability** + - Test adding magnet links through the right-click context menu + - Report missing menu entries or wrong client targeting + - Check behavior across different sites and link types 3. **Cross-Browser Testing** - Test on Chrome, Edge, and Firefox @@ -197,7 +203,7 @@ npm run build:firefox ### How to Report Bugs -**GitHub Issues**: https://github.com/YOUR_USERNAME/CTRL/issues +**GitHub Issues**: https://github.com/StarlightDaemon/CTRL/issues **Please include**: 1. **Browser**: Chrome/Edge/Firefox + version @@ -217,23 +223,22 @@ npm run build:firefox - [ ] **10+ active beta testers** providing feedback - [ ] **<5 critical bugs** discovered -- [ ] **All 9 clients** verified working +- [ ] **All 10 clients** verified working - [ ] **Positive user feedback** on core functionality - [ ] **No data loss** or credential security issues ### Roadmap to v1.0 -**Next Release: v0.3.0** (Estimated: Week 4-7) -- ✅ Migrate 1337x to Shadow DOM -- ✅ Integrate YTS.mx (#1 movie site) -- ✅ Implement E2E testing with Playwright -- ✅ Performance benchmarking +**Next Release: v0.3.x** (Timing TBD) +- ✅ Continue post-beta stabilization and adapter hardening +- ✅ Maintain Playwright E2E infrastructure (CI runs non-@integration subset) +- ✅ Continue performance benchmarking and tuning -**Production Release: v1.0** (Estimated: Week 13-16) +**Production Release: v1.0** (Timing TBD) - ✅ Chrome Web Store submission - ✅ Firefox AMO submission - ✅ Code signing for installers -- ✅ Full E2E test coverage +- ⬜ Full E2E test coverage (not yet achieved) - ✅ Accessibility score >90 --- @@ -248,7 +253,7 @@ npm run build:firefox - ✅ Credentials encrypted with AES-GCM locally - ✅ Open source - code is auditable -**Privacy Policy**: [View Full Policy](https://YOUR_USERNAME.github.io/CTRL/privacy) +**Privacy Policy**: [View Full Policy](PRIVACY_POLICY.md) --- @@ -257,24 +262,22 @@ npm run build:firefox ### New Features - 🎉 First public beta release - ✅ Multi-server management -- ✅ 9 torrent client adapters +- ✅ 10 torrent client adapters - ✅ Encrypted credential vault - ✅ 7 language translations - ⛔ **Site Integrations**: Removed for stability and store compliance. ### Testing -- ✅ 153 unit tests passing -- ✅ All adapter tests passing -- ⚠️ E2E tests pending +- ✅ Unit and adapter test suites are part of the maintained validation baseline +- ✅ Playwright E2E tests configured (CI runs non-@integration subset) --- ## 💬 Community & Support -**Questions?** Open a [Discussion](https://github.com/YOUR_USERNAME/CTRL/discussions) -**Bugs?** Create an [Issue](https://github.com/YOUR_USERNAME/CTRL/issues) -**Email**: [your-email@domain.com] +**Questions?** Open a [Discussion](https://github.com/StarlightDaemon/CTRL/discussions) +**Bugs?** Create an [Issue](https://github.com/StarlightDaemon/CTRL/issues) --- @@ -283,7 +286,7 @@ npm run build:firefox - [Main README](../README.md) - Project overview - [ROADMAP](../ROADMAP.md) - Strategic direction - [CONTRIBUTING](../CONTRIBUTING.md) - How to contribute -- [Privacy Policy](https://YOUR_USERNAME.github.io/CTRL/privacy) - Full privacy details +- [Privacy Policy](PRIVACY_POLICY.md) - Full privacy details --- @@ -305,4 +308,4 @@ Your feedback is invaluable in making CTRL a production-ready extension. Thank y *CTRL v0.2.0-beta.1* *Released: January 2026* -*Next Release: v0.3.0 (Week 4-7)* +*Next Release: v0.3.x (Timing TBD)* diff --git a/docs/PRIVACY_POLICY.md b/docs/PRIVACY_POLICY.md index 0a06c13..94f8934 100755 --- a/docs/PRIVACY_POLICY.md +++ b/docs/PRIVACY_POLICY.md @@ -1,6 +1,6 @@ # Privacy Policy -**Last Updated**: January 2026 +**Last Updated**: April 2026 **Effective Date**: January 2026 --- @@ -134,7 +134,7 @@ We may update this privacy policy from time to time. Changes will be posted on t CTRL is open-source software. You can inspect the source code to verify our privacy claims: -**GitHub Repository**: https://github.com/YOUR_USERNAME/CTRL +**GitHub Repository**: https://github.com/StarlightDaemon/CTRL The code shows: - No analytics libraries @@ -152,8 +152,8 @@ BitTorrent is a legitimate protocol used for distributing open-source software, If you have questions about this privacy policy or CTRL's data practices: -- **Email**: [your-email@domain.com] -- **GitHub Issues**: https://github.com/YOUR_USERNAME/CTRL/issues +- **GitHub Discussions**: https://github.com/StarlightDaemon/CTRL/discussions +- **GitHub Issues**: https://github.com/StarlightDaemon/CTRL/issues --- diff --git a/docs/privacy.html b/docs/privacy.html index ee50316..fd8942a 100755 --- a/docs/privacy.html +++ b/docs/privacy.html @@ -126,7 +126,7 @@
CTRL injects user interface components into torrent indexing websites (e.g., TorrentGalaxy, 1337x, Nyaa) to provide one-click "Add to Client" functionality.
+CTRL operates only when you explicitly interact with it. It does not automatically modify web pages or background-monitor your browsing activity.
+How you interact with CTRL:
+magnet:?xt=...) and adds them to your selected client.What happens:
What does NOT happen:
notificationsPurpose: To notify you when downloads complete or errors occur.
Data Access: None. Notifications are created locally.
-host_permissions (specific domains)Purpose: To inject UI components on supported torrent indexing sites.
-Data Access: Only the ability to detect magnet links (href attributes) on these specific sites. No page content is read or transmitted.
+activeTabPurpose: To generically scan the current page for magnet links when you manually select the "Scan Page" option from the context menu.
+Data Access: Only the ability to identify magnet link URLs (href attributes) on the page you are currently viewing and have interacted with.
optional_host_permissionsPurpose: To allow communication with your self-hosted torrent client (for example qBittorrent or Transmission).
+Data Access: Permissions are only requested for the specific URL of your torrent client. No data from other websites is accessed using these permissions.
Since CTRL does not collect any personal data, there is no data for you to request, correct, or delete from our servers (because we don't have servers).
@@ -257,7 +268,7 @@CTRL is open-source software. You can inspect the source code to verify our privacy claims:
-GitHub Repository: https://github.com/YOUR_USERNAME/CTRL
+GitHub Repository: https://github.com/StarlightDaemon/CTRL
The code shows:
If you have questions about this privacy policy or CTRL's data practices: