zoriya/flood
1
0
Fork 0
mirror of https://github.com/zoriya/flood.git synced 2025-12-05 23:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add notes about upstream rtorrent json-rpc (#845)

Browse Source
This commit is contained in:
Trim21
2025-01-21 21:30:37 +08:00
committed by GitHub
parent c8b594b27c
commit a263590a8e
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -15,6 +15,20 @@ Flood is a monitoring service for various torrent clients. It's a Node.js servic
| [Transmission](https://github.com/transmission/transmission) | :white_check_mark: ([tested](https://github.com/jesec/flood/blob/master/server/.jest/transmission.setup.js)) |
| [Deluge](https://github.com/deluge-torrent/deluge) v2+ | :alembic: Experimental |
##### RTorrent Notes
For now, rakshasa/rtorrent and jesec/rtorrent are both supported.
If you are using rakshasa/rtorrent>0.15.1 (upstream rtorrent with json-rpc support),
you will need to add these options to your config:
```ini
method.redirect=load.throw,load.normal
method.redirect=load.start_throw,load.start
method.insert=d.down.sequential,value|const,0
method.insert=d.down.sequential.set,value|const,0
```
#### Integrating with Flood
APIs are officially documented inline by the [comments](https://github.com/jesec/flood/blob/f7019001dd81ee8401c87d4c4cd6da6f5f520611/server/routes/api/torrents.ts#L106-L117) and [types](https://github.com/jesec/flood/blob/f7019001dd81ee8401c87d4c4cd6da6f5f520611/shared/schema/api/torrents.ts#L10-L32).