Skip to main content

Multiclient bittorrent webui

Project description

This is a web frontend that can combine multiple torrent clients into one. Designed for the power-user who wants an overview and manage existing torrents.

The interface is based on ag-grid to provide stellar performance even with a large amount of torrents. As a plus it will also look a bit like a spreadsheet.

spreadsheetui.png

Requirements

  • Python 3.7 or higher

Installation

Linux

# Create a folder to put it all into
mkdir spreadsheetui
cd spreadsheetui

# Create a python virtual environment and install spreadsheetui into it
python3 -m venv env
env/bin/pip install spreadsheetui

# Download an example config file, remember to modify it
curl -L -o config.toml https://github.com/JohnDoee/spreadsheetui/raw/master/config.toml.example

# Start the UI
env/bin/twistd spreadsheetui

Docker

# Create a folder to put it all into
mkdir spreadsheetui
cd spreadsheetui

# Download an example config file, remember to modify it
curl -L -o config.toml https://github.com/JohnDoee/spreadsheetui/raw/master/config.toml.example

curl -L -o docker-compose.yml https://github.com/JohnDoee/spreadsheetui/raw/master/docker-compose.yml
docker-compose up -d

Configuration

Edit config.toml to fit your needs.

Remember to change username, password. The secret_key should also be changed, anything random will do.

You can add as many clients as you want, see the provided examples for syntax.

When you are done and have started Spreadsheet UI, it is accessible on port 18816

If you need to use a proxy layer to access your client (e.g. with Docker) check out liltorrent.

Moving torrents

For torrent moving to work, the session_path must be correct, see more about session_path here

Executing jobs

Jobs in SpreadsheetUI works by using a jobqueue. This means jobs are not executed before you trigger them so you can make sure all your scheduled jobs are as you want then to be.

How to run a job

  • Select some torrents

  • Right-click and select the action you want (e.g. stop)

  • Right-click and click “Goto Jobqueue”

  • Verify your scheduled jobs

  • Right-click and click “Execute queued jobs”

Your jobs will now slowly be executed in order.

To go back to the dashboard: Right-click and click “Goto Dashboard”

The changes might be slow to show up in your torrent list. If you want to force a full update, right-click and click “Run full update”

Features

Clients:

  • rtorrent

  • Deluge

  • Transmission

  • qBittorrent

Methods:

  • List all torrents

  • Start / stop torrents

  • Move torrents between clients

Logo / icon

spreadsheet by Adrien Coquet from the Noun Project

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spreadsheetui-1.2.0.tar.gz (610.8 kB view details)

Uploaded Source

File details

Details for the file spreadsheetui-1.2.0.tar.gz.

File metadata

  • Download URL: spreadsheetui-1.2.0.tar.gz
  • Upload date:
  • Size: 610.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.10

File hashes

Hashes for spreadsheetui-1.2.0.tar.gz
Algorithm Hash digest
SHA256 96a53daf89228e63623d2cd69431c0eda304330a40dbc29f554e82de33f98df7
MD5 c1f268415cbab1d4cb8b8e7d6c0bd8fd
BLAKE2b-256 d1d0975ce4fe6fc127d9d9008f7a9c0ae24919c973e74772cf71e6ac19309a51

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page