@jesec/flood 0.0.0-master.b00572a → 0.0.0-master.b0968ef

package/CHANGELOG.md

@@ -1,5 +1,465 @@
 # Changelog
 
+## [4.11.0] (October 17, 2025)
+
+- feat: show size for status filter (#923)
+- fix: improve server startup message (#921)
+
+## [4.10.0] (October 4, 2025)
+
+- feat: Add optional Last Activity column to torrent list (#906)
+- feat(client): add units of measure to throttle speeds (#899)
+- feat: show 2 decimal in size usage (#916)
+- fix: `LoadingOverlay` sometimes does not hide after login/logout (#905)
+- fix: log authentication failed reasons (#882)
+- Migrate webpack devServer proxy options to webpack v5 (#904)
+- i18n: new translations (#919, #918)
+- build(deps-dev): bump form-data from 4.0.1 to 4.0.4 (#900)
+- build(deps-dev): bump axios from 1.8.2 to 1.12.0 (#912)
+- build(deps-dev): bump tar-fs from 2.1.3 to 2.1.4 (#914)
+
+## [4.9.5] (June 9, 2025)
+
+- ci: use new pkg (#891)
+- build(deps-dev): bump fastify from 4.29.0 to 4.29.1 (#881)
+- build(deps-dev): bump tar-fs from 2.1.2 to 2.1.3 (#884)
+- build(deps-dev): bump axios from 1.7.9 to 1.8.2 (#886)
+- build(deps-dev): bump webpack-dev-server from 4.15.2 to 5.2.1 (#885)
+- i18n: new translations (#889)
+
+## [4.9.4] (June 9, 2025)
+
+- build: add ghcr.io docker image
+- build(deps-dev): bump esbuild from 0.19.12 to 0.25.0 (#869)
+- build: replace deprecated `pkg` with `@yao-pkg/pkg` (#868)
+- i18n: new translations (#863)
+- ci: replace apt with apt-get (#860)
+
+## [4.9.3] (January 30, 2025)
+
+- build: upgrade deps (#858)
+- docs: fix readme badge (#857)
+
+## [4.9.2] (January 30, 2025)
+
+- ci: always use version from package.json from ci (#855)
+- ci: upload deb with gh cli to avoid override (#854)
+
+## [4.9.1] (January 30, 2025)
+
+- i18n: new translations (#852)
+- ci: use bazel@7 to build deb (#851)
+
+## [4.9.0] (January 15, 2025)
+
+- feat: add filter by filesystem location + bonus tooltip on overflowed filter names (#518)
+- fix(ui): some dark mode fixes (#714)
+- fix: check if user service is bootstrapped before removing instances (#835)
+- fix: run compaction every interval (#834)
+- docs: add notes about upstream rtorrent json-rpc (#845)
+- i18n: new translations (#848, #841)
+- build(deps): bump nanoid from 3.3.7 to 3.3.8 (#833)
+
+## [4.8.5] (December 10, 2024)
+
+- fix(rTorrent): support xmlrpc int type (#829)
+- fix(rTorrent): prevent extra commas in serialized XML (#830)
+- fix(qBittorrent): api version state handling (#826)
+- fix(qBittorrent): Missing states (#817)
+- build: remove deprecated package `frontmatter-markdown-loader` (#831)
+- build(deps): bump cross-spawn from 7.0.3 to 7.0.5 (#823)
+- build(deps): bump http-proxy-middleware from 2.0.6 to 2.0.7 (#816)
+- i18n: new translations (#821)
+- ci: fix docker-dbg job (#822)
+
+## [4.8.4] (October 9, 2024)
+
+- fix: add_paused changed to add_stopped in qbit 5 (#810)
+- ci: fix release workflow (#808)
+- build(deps-dev): bump express from 4.19.2 to 4.20.0 (#805)
+- build(deps-dev): bump body-parser from 1.20.2 to 1.20.3 (#804)
+- build(deps): bump find-my-way from 8.2.0 to 8.2.2 (#807)
+- build(deps-dev): bump webpack from 5.93.0 to 5.94.0 (#806)
+
+## [4.8.3] (October 8, 2024)
+
+- fix: resume and pause does not work with qbittorrent 5 (#801)
+- fix: changed transmission ratio calculation to total size instead of downloaded size (#791)
+- fix: correct buffers concatenation in socket (#787)
+- style: add new rule for imports (#785)
+- build: fix docker warn (#784)
+- build: enable pnpm link (#783)
+- build: embed mmdb as pure js data (#782)
+- build: remove deprecated babel plugin (#781)
+- i18n: new translations (#802)
+
+## [4.8.2] (May 4, 2024)
+
+nothing new, just a new release to for deb files.
+
+## [4.8.1] (May 4, 2024)
+
+- feat: new args `--disable-rate-limit` to disable rate limit on api except login (#737)
+- fix: only generate mediainfo for video file (#741)
+- fix: `/metainfo` json response for error (#740)
+
+## [4.8.0] (April 24, 2024)
+
+- fix(client): filter empty tags when setting/submitting tags (#715)
+- fix(client): modal overflow on mobile (#713)
+- fix(server): content-type on responding html (#708)
+- fix(client): allows modal to grow when inner width exceeds container (#597)
+- fix(client): misc styles (#691)
+- fix(server): `@fastify/express` doesn't work with http2 (#705)
+- fix(client): tracker filter size conditional render logic and react key prop (#702)
+- fix: log error trace (#697)
+- fix(server): handle number port (#692)
+- feat(client): detect magnet and torrent links from clipboard (#690)
+- server: remove port requirement, permit running on paths (#680)
+- perf: mediainfo router should use async/await to get file info (#656)
+- feat: use relative path in mediainfo info (#657)
+- TorrentGeneralInfo: drop leading and trailing whitespaces from comment (#674)
+- LinkedText: fix torrent comment line break (#667)
+- server: rTorrent: manage request queue with p-queue - fix memory leak (#650)
+- TransferRateGraph: explicitly declare width and height to 100%
+- server: qBittorrent: use POST method for API calls
+- server: qBittorrent: log in using POST method (#594)
+- server: torrentService: normalize case of hash during torrent lookup
+- TorrentListColumns: add "Finished" column (#565)
+- styles: sortable-list: disallow selecting text in a list
+- client: scripts: development: drop unnecessary browser popup
+- MoveTorrentsModal: suggest longest common prefix as path
+- server: rTorrent: throw error when file moving fails
+- FilesystemBrowser: line break unconditionally for long paths
+- TorrentListDropzone: pop up "Add Torrents" modal instead of adding directly
+- server: rTorrent: avoid relying on type coercion of RPC value
+- server: rTorrent: remove "hasLoadThrow" and fold into "isJSONCapable"
+- server: ditch unmaintained "spdy"
+- SortableList: switch to clauderic/dnd-kit
+- server: drop databases before removing user
+- server: switch to @seald/nedb
+- server: tests: replace "ts-jest/utils" with "ts-jest"
+- TorrentGeneralInfo: display "None" when there is no comment
+- LinkedText: drop RegEx incompatible with Safari
+- feature: display comment inside .torrent in torrent details (#541)
+- TransferRateGraph: fix blank graph in some cases
+- TorrentList: fix "a wild 0 appears"
+- client: Fix regression introduced in PR #519, fixes #522 (#523)
+- sidebar: make filter sections collapsible (#519)
+- client: add page title speed display preference
+- DownloadRulesTab, FeedsTab: force new component when editing
+- server: add shebang to bundled executable
+- Dockerfile: use the "npm run build" command
+- server: create production build with webpack directly
+- server: flatten directory structure a bit
+- server: tests: ensure connectivity to client before tests
+- server: tests: confirm deletion of torrents before continue
+- client: reformat "typings.d.ts", fixup ffcc5c8e0
+- server: tests: mock response to torrents fetch
+- server: normalize fetching of torrents added with URL
+- client: fix webpack devServer port selection
+- styles: apply dark theme to TorrentListDropzone
+- TorrentFilterStore: simplify and fix scroll to top on filter change
+- client: allow multi-select of filters with Ctrl and Shift keys
+- server: remove unused history snapshots and make it in-mem only
+- TagFilters, TrackerFilters: fix filtering by tag/tracker
+- client: remove unnecessary "UIActions" abstraction
+- server: Transmission: normalize "unknown" ETA (-2) to infinity (-1) (#432)
+
+## [4.7.0] (October 9, 2021)
+
+- Display total size by tag or tracker of torrents on sidebar (#369, @sabersalv)
+- Improve memoization of "TorrentListRow" and "ProgressBar" components
+- Fix loading indicator bar alignment (#396, @DopyConqueror)
+- New translations
+  - Arabic, thanks to yngams
+  - Chinese Simplified, thanks to @davidxuang
+  - Czech, thanks to @Kedlub
+  - Italian, thanks to @GiorgioBrux
+  - German, thanks to @Kiina
+  - Japanese, thanks to @Kuri0421 and @Kiina
+  - Korean, thanks to @Kiina
+  - Polish, thanks to @retmas-gh
+  - Spanish, thanks to @oaknuggins
+  - Norwegian, thanks to Daddie0
+- Bump dependencies
+
+## [4.6.1] (July 5, 2021)
+
+- DiskUsage: skip mount points of "overlayfs" type (#341, @Trim21)
+- Deluge:
+  - Avoid crashing Flood when there is a connection error
+  - Note again that Deluge support is still experimental
+- Bug fixes:
+  - Cleanup synchronous patterns (#340)
+  - AuthForm: add missing i18n for "Username" and "Password" (#336)
+  - server: destroy user services before cleaning up data
+  - TorrentListCell: passthrough clicks
+- New translations
+  - French, thanks to @foXaCe
+  - German, thanks to @chint95
+  - Korean, thanks to @Kiina
+  - Romanian, thanks to @T-z3P
+- Bump dependencies
+
+## [4.6.0] (May 28, 2021)
+
+- Experimental Deluge support
+  - caveat: tags are not supported at the moment
+- Add "last active date" and "finished date" to the torrent properties
+- Migrate stylesheets to SCSS module system
+- Ditch inefficient "TRANSFER_SUMMARY_DIFF_CHANGE" SSE event
+- Allow to download contents of multiple selected torrents
+- Update base Node.js versions of single-executable builds
+- rTorrent:
+  - Add torrents to rTorrent via socket
+- qBittorrent:
+  - Improve performance by throttling concurrent requests
+- Bug fixes:
+  - Fix memory leak and unreliability when the settings of a user is updated by simplifying service manager
+  - Pipe created torrent to response directly
+- Security enhancements:
+  - Forbid non-owner access to runtime directory by default
+- New translations
+  - Chinese (Simplified), thanks to @coxde
+  - Czech, thanks to @brezinajn
+  - German, thanks to @chint95
+  - Hungarian, thanks to @m3r3nix
+  - Korean, thanks to @Kiina
+  - Spanish, thanks to Zagon
+- Bump dependencies
+
+## [4.5.4] (April 24, 2021)
+
+- Bug fixes:
+  - "Torrents with long names get truncated in torrent detail modal (#273)" on Safari
+- New translations
+  - Chinese (Simplified), thanks to @coxde
+  - Dutch, thanks to John Willemsen
+  - Italian, thanks to Simone De Nadai
+- Bump dependencies
+
+## [4.5.3] (April 10, 2021)
+
+- Bug fixes:
+  - Tags need a F5 refresh to be displayed after being set (#266)
+  - Torrents with long names get truncated in torrent detail modal (#273)
+  - qBittorrent: allow .torrent download with new session directory path (#275, @angristan)
+- New translations
+  - French, thanks to @foXaCe
+  - Hungarian, thanks to @m3r3nix
+  - Japanese, thanks to @Kiina
+  - Korean, thanks to @Kiina
+  - Spanish, thanks to @Shutruk
+- Bump dependencies
+
+## [4.5.2] (April 4, 2021)
+
+- Add "Log Out" button to connection interrupted page
+- Add "tini" init process to containers (#260, @onedr0p)
+- Bug fixes:
+  - No longer fails to add some URLs to rTorrent with XMLRPC
+  - Fix `Connection settings can not be empty.` after submit
+- Bump dependencies
+
+## [4.5.1] (March 31, 2021)
+
+- Allow to press Ctrl-A or Command-A to select all torrents
+- Enlarge width of "Torrent Details" modal
+- Bug fixes:
+  - Fix multi-file "Move torrents" of rTorrent (XMLRPC)
+  - Don't close the notification panel when a button is clicked
+- New translations
+  - Czech, thanks to @brezinajn
+  - Italian, thanks to @gmcinalli
+  - Korean, thanks to @Kiina and @m4ximuel
+- Bump dependencies
+
+## [4.5.0] (March 14, 2021)
+
+- Reannounce. Typically torrent clients do that automatically, but in some cases you may want to do it manually. It is available as a context menu action.
+- Redesigned filesystem browser. Allow searching in the current directory and eliminate unnecessary requests sent to server. Additionally, navigation via arrow keys is implemented (mainly for accessibility but could be useful for anyone).
+- Major accessibility enhancements. All elements are now navigable by keyboard.
+- Improve scrolling performance by overscanning 30 rows.
+- rTorrent:
+  - JSON-RPC support for eligible versions. Preliminary tests showed that, when compared with XMLRPC, JSON-RPC yields 2x performance, 15% lower total CPU time in rTorrent process, 33% lower total CPU time in Flood process.
+  - `load.throw` command support for eligible versions. Definitive response when you add torrents, so Flood won't display success when the operation actually fails.
+  - Better handle command failures.
+  - Verify filesystem access and respond with errors when necessary.
+- Bug fixes:
+  - Fix French mistranslation
+  - Fix button location in download rules tab of feed modal
+  - Fix "Set tracker" of single tracker torrents in rTorrent
+  - Fix "Checking" bar selected style for dark color scheme
+  - Recognize qBittorrent's "Forced" state
+  - Disk usage service errors are no longer fatal
+- New translations
+  - Chinese (Simplified), thanks to @MeetWq
+  - Chinese (Traditional), thanks to @vongola12324
+  - Czech, thanks to @brezinajn
+  - French, thanks to @Carryozor and @foXaCe
+  - German, thanks to @chint95
+  - Hungarian, thanks to @m3r3nix
+  - Romanian, thanks to @T-z3P
+- Bump dependencies
+
+## [4.4.1] (February 6, 2021)
+
+- Better handle tracker domain conversion and grouping
+- Wrap texts (e.g. long IPv6 addresses and peer client versions) in tables of torrent details if necessary
+- Distribution:
+  - CI now publishes releases to AUR (Arch Linux User Repository)
+  - CI now publishes Debian (`.deb`) packages to Github Releases
+  - Contributions are welcome. See [distribution/README.md](https://github.com/jesec/flood/blob/v4.4.1/distribution/README.md).
+- rTorrent fixes:
+  - Remove [] from IPv6 addresses in peer list
+- Bug fixes:
+  - Remove ugly outline and highlight of focused button caused by an a11y change
+  - Try to workaround potential index.html caching issues
+    - Browser uses a fully cached asset tree in some cases, which defeats cache busting by asset hashes
+- New translations
+  - Finnish, thanks to @hyvamiesh
+  - German, thanks to @chint95
+- Bump dependencies
+
+## [4.4.0] (February 2, 2021)
+
+- Return a portable link when torrent content is requested
+  - Allow sharing of links to other people
+  - Allow casting (Chromecast, Airplay) of content to devices which can't authenticate with Flood
+  - Allow copying the link and paste it to a player application so more formats can be streamed
+  - Allow external downloaders to use the link
+- Allow to register to handle magnet links in "Add by URL" panel
+  - Support for "add-urls" frontend query action is added
+  - e.g. `http://localhost:3000/?action=add-urls&url=magnet:?xt=`
+- Allow to download .torrent file of a torrent
+- Add sequential downloading support for applicable clients
+  - rTorrent: requires "d.down.sequential(.set)" commands, see [jesec/rtorrent@bd904e3](https://github.com/jesec/rtorrent/commit/bd904e366367cb9cbe007381089eea066253c9e9)
+  - qBittorrent: supported
+  - Transmission: rejected, see [https://trac.transmissionbt.com/ticket/452](https://trac.transmissionbt.com/ticket/452)
+- Add initial seeding (aka superseeding) support for applicable clients
+  - [BEP16](https://www.bittorrent.org/beps/bep_0016.html)
+    - Saves bandwidth for initial seeder and quickly kicks off a healthy swarm
+    - NOT recommended for non-initial seeders
+  - rTorrent: not exposed to RPC interface, requires [jesec/rtorrent@657089d](https://github.com/jesec/rtorrent/commit/657089d438f917714c2386c28ce9d01a6e6a2737)
+  - qBittorrent: supported
+  - Transmission: not supported, see [https://trac.transmissionbt.com/ticket/1691](https://trac.transmissionbt.com/ticket/1691)
+- Display existing tags in alphabetical order in tag selector
+- Optionally skip assets serving with `--assets=false`
+  - May be useful for users who serve static assets from their own servers
+  - Or developers who don't want to build assets before starting a server instance
+- Refresh manifest and assets related to PWA (Progressive Web Application) support
+- Separate locale and language when using "Automatic" language setting
+  - Deal with minor locale differences (e.g. date formats) between language variants
+  - See [#123](https://github.com/jesec/flood/issues/123)
+- Remove inconsistency of clients by normalizing hashes in API responses to upper case
+- Explicitly pass paths of contents to mediainfo
+  - So unrelated files in the same folder won't be processed by mediainfo
+- Remove dependency on shell in disk usage functions
+  - New distribution-less (distroless) Docker image is now available, which has smaller size and allows maximum security
+- Standalone executable:
+  - Now available for `linux-arm64` and `win-arm64`
+  - Bundled Node.js runtime bumped to 14.15.4
+  - Linux binaries are now fully static
+  - Customized Node.js runtime with smaller size and memory consumption
+- rTorrent fixes:
+  - Create destination directory structure before moving torrent
+  - Flood API responses no longer mixes with unprocessed rTorrent method call responses
+  - Properly handle multi tags while adding
+  - Remove torrents (with data) can delete empty directories
+- qBittorrent fixes:
+  - Fix "isBasePath" for newer versions
+  - Implement "isCompleted" (skip_checking)
+  - Trim whitespace in `tags` property
+  - Optionally set website cookie for torrent fetching (add by URL)
+- Security enhancements:
+  - Don't leak details of internal errors
+  - Rate limits /data API endpoint
+- Bug fixes:
+  - Pack torrent contents one by one to avoid out-of-memory during batch downloading
+  - Potential crashes related to disk usage functions in rare Docker environments
+  - Disallow comma in tag
+- New translations
+  - Chinese (Traditional), thanks to @vongola12324
+  - Czech, thanks to @brezinajn
+  - Dutch, thanks to @vain4us
+  - French, thanks to @Carryozor
+  - German, thanks to @Ben-Wallner
+  - Hungarian, thanks to @m3r3nix
+  - Romanian, thanks to @T-z3P
+  - Spanish, thanks to @almontegil
+- Bump dependencies
+
+Additionally, Sonarr [#4159](https://github.com/Sonarr/Sonarr/pull/4159) and Radarr [#5552](https://github.com/Radarr/Radarr/pull/5552) now supports Flood natively.
+
+**Notes about sequential downloading:**
+
+Drawbacks:
+
+- https://wiki.vuze.com/w/Sequential_downloading_is_bad
+
+Benefits:
+
+- Sequential downloading helps with I/O performance and lowers resource consumption and cost of hardware. It enables predictable I/O patterns and efficient caching. My hard disk is really noisy while downloading a torrent. But with sequential downloading, it does not make a sound. Speed is much better as well. Sequential I/O patterns also eliminate disk fragmentation problem that damages performance/lifespan of hard disks in long-term, which is a headache for long seeders.
+- "It is bad for swarms." That's correct for unhealthy swarms. However, for private torrent users, in most cases, the seeder/leecher relationship is "many seeder, single/little leecher". Plus, with the incentives/punishments of tracker sites, there is little to no risk of "draining". As such, it makes more sense to protect hardware of everyone in the swarm. Predictable I/O patterns also allow seeders to seed many torrents more efficiently: if leechers use sequential download, the read patterns become predictably sequential, which allows better I/O performance and reduces the failure rate of hard disks.
+- For seedbox users: seedboxes are virtual machines. That means many users share the same physical machine. Random chunk downloading is extremely taxing on disks. As a result, usually the speeds are limited by I/O more than bandwidth. If the swarm pattern is usually "many seeder, single leecher", sequential downloading can help a lot.
+- Widely known "self" benefits: stream early, stream while downloading, organize episodes quick and unpack some files before finish, etc.
+
+## [4.3.1] (December 10, 2020)
+
+- Make theme button always at the bottom of sidebar
+- Remove legacy font formats from static assets
+- Slightly tweak styles of country flags in peer list
+  - Better accommodate longer flags
+  - Display country code on hover
+- qBittorrent fixes:
+  - Attach cookies to URL downloads
+  - Set trackers
+- Transmission fixes:
+  - Percentage downloaded of contents of a torrent
+- Bug fixes:
+  - API call to get peer list of a non-existent torrent no longer crash Flood server
+  - Handle file not exist and access denied cases in content download
+  - Properly handle API call to update password of a user
+- Security enhancements:
+  - Rate limit resource-intensive mediainfo request
+  - Ensure path is allowed for mediainfo request
+  - API call to list users no longer receive hashed passwords and client connection settings
+    - Note: only an authenticated admin user may list users
+- New translations
+  - Czech, thanks to @brezinajn
+  - Romanian, thanks to @T-z3P
+- Bump dependencies
+
+## [4.3.0] (December 1, 2020)
+
+- Generate magnet link from torrent
+- Add a button to allow user to switch color scheme
+- Multi architecture Docker images
+  - linux/amd64
+  - linux/arm64 (new)
+  - linux/arm/v7 (new)
+- Allow to display precise percentage
+  - Expanded view: 1 decimal place
+  - Details: 3 decimal places
+- Mountpoints with very long paths are ignored by disk usage
+- Tags can be attached while adding torrents to qBittorrent (needs qbittorrent/qBittorrent#13882)
+- Bug fixes:
+  - Download destination fallback to rTorrent default destination (Mika-/torrent-control#105)
+  - Properly catch errors of AddFiles and AddURLs when using qBittorrent
+  - Display existing trackers in set trackers modal
+- New translations
+  - Spanish, thanks to @vain4us
+- Bump dependencies
+
+Side note:
+
+I am starting to maintain a distribution of rTorrent, available at [jesec/rtorrent](https://github.com/jesec/rtorrent). It is optimized and small. It uses modern CMake and Bazel build systems. Bazel can also be used for dependency management and to produce statically linked reproducible builds.
+
+Static binaries (amd64, arm64) can be downloaded via [Github Actions](https://github.com/jesec/rtorrent/actions?query=workflow%3A%22Publish+rolling+build%22). Docker images are also available at [jesec/rtorrent](https://hub.docker.com/r/jesec/rtorrent).
+
+I made a simple [Dockerfile](https://github.com/jesec/flood/blob/5cc56067c3be6c91ccf94f71d4784be99c2823f8/Dockerfile.rtorrent) to demonstrate how to integrate rTorrent with Flood.
+
 ## [4.2.0] (November 25, 2020)
 
 - Allow content of a torrent to be streamed directly if supported by browser
@@ -118,7 +578,7 @@ Other changes:
 - config.cli: make all configs configurable by options and env
 - styles: properly set width of clipboard icon (fixes #26)
 - client: hide logout button when auth is disabled
-- Hungarian support (#21), thanks to @sfu420
+- Hungarian support (#21), thanks to @m3r3nix
 - New translations:
   - Chinese Traditional, thanks to @vongola12324
   - Czech, thanks to @brezina.jn
@@ -230,3 +690,29 @@ Other changes:
 [4.1.1]: https://github.com/jesec/flood/compare/v4.1.0...v4.1.1
 [4.1.2]: https://github.com/jesec/flood/compare/v4.1.1...v4.1.2
 [4.2.0]: https://github.com/jesec/flood/compare/v4.1.2...v4.2.0
+[4.3.0]: https://github.com/jesec/flood/compare/v4.2.0...v4.3.0
+[4.3.1]: https://github.com/jesec/flood/compare/v4.3.0...v4.3.1
+[4.4.0]: https://github.com/jesec/flood/compare/v4.3.1...v4.4.0
+[4.4.1]: https://github.com/jesec/flood/compare/v4.4.0...v4.4.1
+[4.5.0]: https://github.com/jesec/flood/compare/v4.4.1...v4.5.0
+[4.5.1]: https://github.com/jesec/flood/compare/v4.5.0...v4.5.1
+[4.5.2]: https://github.com/jesec/flood/compare/v4.5.1...v4.5.2
+[4.5.3]: https://github.com/jesec/flood/compare/v4.5.2...v4.5.3
+[4.5.4]: https://github.com/jesec/flood/compare/v4.5.3...v4.5.4
+[4.6.0]: https://github.com/jesec/flood/compare/v4.5.4...v4.6.0
+[4.6.1]: https://github.com/jesec/flood/compare/v4.6.0...v4.6.1
+[4.7.0]: https://github.com/jesec/flood/compare/v4.6.1...v4.7.0
+[4.8.0]: https://github.com/jesec/flood/compare/v4.7.0...v4.8.0
+[4.8.1]: https://github.com/jesec/flood/compare/v4.8.0...v4.8.1
+[4.8.2]: https://github.com/jesec/flood/compare/v4.8.1...v4.8.2
+[4.8.3]: https://github.com/jesec/flood/compare/v4.8.2...v4.8.3
+[4.8.4]: https://github.com/jesec/flood/compare/v4.8.3...v4.8.4
+[4.8.5]: https://github.com/jesec/flood/compare/v4.8.4...v4.8.5
+[4.9.0]: https://github.com/jesec/flood/compare/v4.8.5...v4.9.0
+[4.9.1]: https://github.com/jesec/flood/compare/v4.9.0...v4.9.1
+[4.9.2]: https://github.com/jesec/flood/compare/v4.9.1...v4.9.2
+[4.9.3]: https://github.com/jesec/flood/compare/v4.9.2...v4.9.3
+[4.9.4]: https://github.com/jesec/flood/compare/v4.9.3...v4.9.4
+[4.9.5]: https://github.com/jesec/flood/compare/v4.9.4...v4.9.5
+[4.10.0]: https://github.com/jesec/flood/compare/v4.9.5...v4.10.0
+[4.11.0]: https://github.com/jesec/flood/compare/v4.10.0...v4.11.0

package/README.md

@@ -2,17 +2,38 @@
 
 [![Flood logo](https://github.com/jesec/flood/raw/master/flood.svg)](https://flood.js.org)
 
-[![Github Actions build status badge](https://github.com/jesec/flood/workflows/Build/badge.svg?branch=master&event=push)](https://github.com/jesec/flood/actions) [![Crowdin](https://badges.crowdin.net/flood/localized.svg)](https://crowdin.com/project/flood) [![Discord server badge](https://img.shields.io/discord/418267176873623553.svg?style=flat-square)](https://discord.gg/Z7yR5Uf)
+[![Build](https://github.com/jesec/flood/actions/workflows/build.yml/badge.svg)](https://github.com/jesec/flood/actions/workflows/build.yml)
+[![Crowdin](https://badges.crowdin.net/flood/localized.svg)](https://crowdin.com/project/flood)
+[![Discord server badge](https://img.shields.io/discord/418267176873623553.svg?style=flat-square)](https://discord.gg/Z7yR5Uf)
 
-Flood is a monitoring service for various torrent clients. It's a Node.js service that communicates with your favorite torrent client and serves a decent web UI for administration. This project is based on the [original Flood project](https://github.com/Flood-UI/flood).
+Flood is a monitoring service for various torrent clients. It's a Node.js service that communicates with your favorite torrent client and serves a decent web UI for administration. [Flood-UI](https://github.com/Flood-UI) organization hosts related projects.
 
 #### Supported Clients
 
-| Client                                                          | Support                              |
-| --------------------------------------------------------------- | ------------------------------------ |
-| [rTorrent](https://github.com/rakshasa/rtorrent)                | Stable and Tested :white_check_mark: |
-| [qBittorrent](https://github.com/qbittorrent/qBittorrent) v4.1+ | Experimental :alembic:               |
-| [Transmission](https://github.com/transmission/transmission)    | Experimental :alembic:               |
+| Client                                                          | Support                                                                                                        |
+| --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| [rTorrent](https://github.com/rakshasa/rtorrent)                | :white_check_mark: ([tested](https://github.com/jesec/flood/blob/master/server/.vitest/rtorrent.setup.ts))     |
+| [qBittorrent](https://github.com/qbittorrent/qBittorrent) v4.1+ | :white_check_mark: ([tested](https://github.com/jesec/flood/blob/master/server/.vitest/qbittorrent.setup.ts))  |
+| [Transmission](https://github.com/transmission/transmission)    | :white_check_mark: ([tested](https://github.com/jesec/flood/blob/master/server/.vitest/transmission.setup.ts)) |
+| [Deluge](https://github.com/deluge-torrent/deluge) v2+          | :alembic: Experimental                                                                                         |
+
+##### RTorrent Notes
+
+For now, rakshasa/rtorrent and jesec/rtorrent are both supported.
+
+#### Integrating with Flood
+
+Flood provides an OpenAPI specification and interactive Swagger UI for API documentation:
+
+- **OpenAPI spec**: Available at `/api/openapi.json`
+- **Swagger UI**: Interactive API documentation at `/api/docs/`
+
+You can also check out:
+
+- [list of unofficial client API libraries](https://github.com/jesec/flood/wiki/List-of-unofficial-client-API-libraries)
+- [list of unofficial API integrations](https://github.com/jesec/flood/wiki/List-of-unofficial-API-integrations)
+
+Flood conforms to [Semantic Versioning](https://semver.org) conventions.
 
 #### Feedback
 
@@ -28,14 +49,16 @@ Check out the [Wiki](https://github.com/jesec/flood/wiki) for more information.
 
 Install [Node.js runtime](https://nodejs.org/). Flood tracks `Current` and provides support to `Active LTS` as well.
 
-- Debian, Ubuntu and RHEL-based distributions users can install latest `nodejs` from [NodeSource](https://github.com/nodesource/distributions) software repository.
-- Windows and MacOS users may use installer.
+- Debian, Ubuntu (`apt`/`.deb`) and Enterprise Linux (`yum`/`dnf`/`.rpm`) -based distributions users can install `nodejs` from [NodeSource](https://github.com/nodesource/distributions) software repository.
+- Windows users can use [winget](https://docs.microsoft.com/en-us/windows/package-manager/winget), [Chocolatey](https://chocolatey.org/packages/nodejs) or installer.
+- macOS users can use [brew](https://brew.sh/) or installer.
+- Check [Node.js website](https://nodejs.org/en/download/package-manager) for more.
 
-**EXPERIMENTAL**: You can download a single-executable build from [Releases](https://github.com/jesec/flood/releases) (or rolling build from [Actions](https://github.com/jesec/flood/actions?query=workflow%3A%22Publish+rolling+build%22)). It bundles `Node.js` and supports `Linux`, `MacOS` and `Windows`.
+Alternatively, download a single-executable build from [Releases](https://github.com/jesec/flood/releases) (or rolling build from [Actions](https://nightly.link/jesec/flood/workflows/publish-rolling/master)). It bundles `Node.js` and supports `Linux`, `macOS` and `Windows`.
 
 ### Installation
 
-`sudo npm i -g flood` or `npx flood`
+(sudo) `npm install --global flood` or `npx flood`
 
 Or use `@jesec/flood` for cutting-edge builds.
 
@@ -76,9 +99,10 @@ Run the installation command again.
   - Flood server performs file operations itself. As such, Flood needs to have permissions/access to the files.
   - Flood only uses the path provided by the torrent client so it needs to have the same filesystem context as the torrent client. If a file is "/path/to/a/file" to the torrent client, it has to be "/path/to/a/file" to Flood in order to get file operations working. It can't be "/mnt/some/different/path/file".
 - rTorrent:
-  - Linux or MacOS users can use package managers such as `apt`, `yum`, `pacman`, `brew` of the platform to install rTorrent.
-  - Windows users can use [Cygwin](https://www.cygwin.com/) to install rTorrent.
+  - Linux users can download the latest static executable (available for `amd64` and `arm64`) from [jesec/rtorrent](https://github.com/jesec/rtorrent). Alternatively, use package managers such as `apt`, `yum`, `pacman` of the platform to install rTorrent.
+  - macOS users can use `brew` to install rTorrent.
   - [Compile](https://github.com/rakshasa/rtorrent/wiki/Installing): XMLRPC support flag (`--with-xmlrpc-c`) is required during compilation.
+  - Certain features (sequential download, initial seeding, etc.) are not available in vanilla rTorrent.
 - Ask for help in the [Flood Discord server](https://discord.gg/Z7yR5Uf).
 
 ### Docker
@@ -93,7 +117,9 @@ Note that you have to let Docker know which port should be exposed (e.g. `-p 300
 
 Don't forget to pay attention to `flood`'s arguments like `--port` and `--allowedpath`.
 
-Currently Docker images of this project don't bundle a torrent client (yet). Its usefulness is limited as a result. You have to install a torrent client inside the container or make it possible for Flood inside Docker to interact with your torrent client.
+Alternatively, you can pass in environment variables instead (e.g. `-e FLOOD_OPTION_port=3000`).
+
+Checkout [Run Flood (and torrent clients) in containers](https://github.com/jesec/flood/discussions/120) discussion.
 
 Filesystem parts in [Troubleshooting](https://github.com/jesec/flood#troubleshooting) are especially important for containers.
 
@@ -107,41 +133,35 @@ Filesystem parts in [Troubleshooting](https://github.com/jesec/flood#troubleshoo
 
 From the root of the Flood directory...
 
-1. Run `npm install`.
-1. Run `npm run build`.
-1. Run `npm start`.
+1. Run `pnpm install`.
+1. Run `pnpm run build`.
+1. Run `pnpm start`.
 
 Access the UI in your browser. With default settings, go to `http://localhost:3000`. You can configure the port via `--port` argument.
 
 **Notes**
 
-- When you use `npm run start` to execute Flood, you have to pass command line arguments after `--`. For example, `npm run start -- --host 0.0.0.0 --port 8080`. This applies to any `npm run` (e.g. `start:development:client`).
+- When you use `pnpm run start` to execute Flood, you have to pass command line arguments after `--`. For example, `pnpm run start -- --host 0.0.0.0 --port 8080`. This applies to any `pnpm run` (e.g. `start:development:client`).
 
 ### Updating
 
 1. To update, run `git pull` in this repository's directory.
 1. Kill the currently running Flood server.
-1. Run `npm install` to update dependencies.
-1. Run `npm run build` to transpile and bundle static assets.
-1. Start the Flood server with `npm start`.
+1. Run `pnpm install` to update dependencies.
+1. Run `pnpm run build` to transpile and bundle static assets.
+1. Start the Flood server with `pnpm start`.
 
 ### Local Development
 
-1. Run `npm install`.
-1. Run `npm run start:development:server` and `npm run start:development:client` in separate terminal instances.
-   - `npm run start:development:server` uses [ts-node-dev](https://www.npmjs.com/package/ts-node-dev) to watch for changes to the server-side source. Or open the folder with VS code and then `Run -> Start Debugging`. You may use a [Javascript IDE](https://code.visualstudio.com/) to debug server codes.
-   - `npm run start:development:client` watches for changes in the client-side source. Access the UI in your browser. Defaults to `localhost:4200`. You may use browser's [DevTools](https://developers.google.com/web/tools/chrome-devtools) to debug client codes.
+1. Run `pnpm install`.
+1. Run `pnpm run start:development:server` and `pnpm run start:development:client` in separate terminal instances.
+   - `pnpm run start:development:server` uses [tsx](https://www.npmjs.com/package/tsx) to watch for changes to the server-side source. Or open the folder with VS code and then `Run -> Start Debugging`. You may use a [Javascript IDE](https://code.visualstudio.com/) to debug server codes.
+   - `pnpm run start:development:client` watches for changes in the client-side source. Access the UI in your browser. Defaults to `localhost:4200`. You may use browser's [DevTools](https://developers.google.com/web/tools/chrome-devtools) to debug client codes.
 
 `--help --show-hidden` shows advanced arguments.
 
 `--proxy` proxies requests from a development client to a URL of your choice (usually URL to a Flood server). It is useful when you wish to do development on the frontend but not the backend. Or when the frontend and backend are being developed on different hosts.
 
-### Environment Variables
-
-1. `DEV_SERVER_PORT`: webpackDevServer's port, used when developing Flood. Defaults to `4200`.
-1. `DEV_SERVER_HOST`: webpackDevServer's host, used when developing Flood. Defaults to `0.0.0.0`.
-1. `DEV_SERVER_HTTPS`: webpackDevServer's protocol, used when developing Flood. Defaults to `http`.
-
 ### Building Docker
 
 1. `docker build --pull --rm -f Dockerfile -t flood:latest .`