RookparcelDocumentation
Rookparcel's documents live in its GitHub repository for now. This page points to them.
Getting started
- DownloadEvery file of the newest release, how to start it, checksums and updating.
- Release notes for 1.2.21What is in the release, the first start on each platform and its known limitations.
- NewsWhat changed in each release, in short, newest first; also as an Atom feed.
- Questions and answersThe license in plain words, settings and portable mode, languages, remote mode, privacy.
- BenchmarksMemory, start time, download speed and CPU time beside qBittorrent, Transmission, Deluge and rTorrent, with the method.
- READMEThe overview, the download table, building from source and the programs' main options.
Guides
- Searching for torrents on WindowsGetting the search helper (Jackett, downloaded at a click), ticking the sites it searches, searching and adding results, with screenshots; using your own Prowlarr or Jackett instead.
- Running rookparcel-nox as a servicesystemd units, the FreeBSD rc.d script, the Windows service,
--daemon, proxies, HTTPS for the Web UI, and where the daemon keeps its files. - The Web UI and remote modeHow the Web UI and its API work, the qBittorrent-compatible subset, languages in the page, and how a desktop GUI drives a remote daemon.
- All release notesThe text of every release, one file per version.
Command line
The everyday options. rookparcel-nox --help lists all of them.
| Command | What it does |
|---|---|
rookparcel-nox run | Starts the daemon and resumes every saved torrent; q and Enter or Ctrl+C stop it cleanly. |
rookparcel-nox run --webui 8080 --webui-pass PASS | The same, with the Web UI and the qBittorrent-compatible Web API on 127.0.0.1:8080 (--webui ADDR:PORT for another address). |
--webui-https | Serves the Web UI over HTTPS with a self-signed certificate made on first use; --webui-cert FILE --webui-key FILE uses yours. |
rookparcel-nox add file.torrent --save DIR | Downloads a torrent into DIR and exits when it is done (--seed keeps seeding until stopped). |
--no-update-check | Starts the daemon without its check for a newer release (1.1.17 and later; the Web UI's Preferences > General > Privacy does the same). |
rookparcel-nox run --verbose | Prints tracker and peer events, useful in a bug report. |
rookparcel-nox --license | Prints the license and the third-party notices. |
rookparcel --remote, rookparcel-gtk --remote | Opens a window that drives a rookparcel-nox elsewhere (File > Connect to Remote... does the same). |
rookparcel --demo 10000 | Windows: opens the window on a simulated engine with 10,000 fake torrents, to try the interface at scale. |
How Rookparcel is made
- ArchitectureThe engine, the frontends and how they fit together.
- Porting libtorrentHow libtorrent 2.0.11 is ported to Rust, and where Rookparcel differs.
- DecisionsThe project's recorded decisions and their reasons: license, name, platforms, languages.
- Security reviewThe review of the parsers that read untrusted input, and its fixes.
- ReleasingHow the release files are built, including the macOS app and the Flatpak.
- This websiteHow this site is built and deployed, and the update file Rookparcel reads.
Status and history
License
- LICENSE.mdThe PolyForm Noncommercial License 1.0.0 (in plain words).
- THIRD-PARTY-NOTICES.mdlibtorrent's BSD-3-Clause license and the code bundled with it.