https://github.com/Trogious/rtremote

rtorrent <- rtremote <- rtorrent remote
https://github.com/Trogious/rtremote

mobile mobile-app torrent torrents

Last synced: 2 months ago
JSON representation

rtorrent <- rtremote <- rtorrent remote

• Host: GitHub
• URL: https://github.com/Trogious/rtremote
• Owner: Trogious
• Created: 2020-01-26T18:07:09.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-11T18:00:17.000Z (over 3 years ago)
• Last Synced: 2024-08-07T18:43:35.371Z (6 months ago)
• Topics: mobile, mobile-app, torrent, torrents
• Language: Python
• Homepage:
• Size: 73.5 MB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# rtremote

![minimum tests (API version)](https://github.com/Trogious/rtremote/workflows/minimum%20tests%20(API%20version)/badge.svg) ![main test suite](https://github.com/Trogious/rtremote/workflows/main%20test%20suite/badge.svg)

`rtremote` is a intermediary server that manages the traffic between your running `rtorrent` client and `rtorrent remote` Android app. The `rtremote` is Open Source and public. The mobile app is not.

## HOWTO

How to run `rtremote` Web Sockets server next to your running rtorrent.

### Downloading

Do not clone this repo, rather get a release from [here](https://github.com/Trogious/rtremote/releases). The repo contains test and test dependencies you don't need.

### Requirements

- rtorrent compile in with `--with-xmlrpc-c` flag

- rtorrent socket file, ususally `.rtorrent.sock`

- Python 3.7+ (3.6.1+ might work as well, but `rtremote` was only tested on 3.7+)

- Python dependencies, installed with `pip install -r requirements.txt`

### Running

- unpack and get into the rtremote directory

- make sure `start.sh` has correct permissions, it needs `+x` to execute

- make sure that `start.sh` (last line) executes correct Python version

- edit the `start.sh` file, makig sure you set all parameters correctly

- secret key needs to be in SHA1 encrypted format, you can get it e.g. whis way: `echo 'abc123' |sha1sum`, where `abc123` is your secret key

### Using

Get `rtorrent remote` app from Google Play store, configure it to point to this server, have fun.

### Troubleshooting

In case of issues, you can increase logging level from INFO (default) to DEBUG by editing `utils.py`.