Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 1.75 KB

README.md

File metadata and controls

68 lines (36 loc) · 1.75 KB

torrent-rs - BitTorrent protocol client

WORK IN PROGRESS

RSBT

Legal

Source code except logo / artwork images is dual-licensed under MIT or the UNLICENSE.

Creative Commons Licence
Artwork which is not part of JHipster is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Features

  • Implements bittorrent client.

Installation

CLI (not really useful):

cargo install --path cli

WEB UI (requires npm to build):

cargo install --features ui --path backend

Development

Read design documents: DESIGN

Install dependencies (requires npm):

cargo xtask install

Start dev Rust+Webpack server in watch mode:

cargo xtask dev

Start only Webpack server in dev mode:

cargo xtask ui-dev

Clean build directories:

cargo xtask clean

Run rsbt cli in Docker to check interaction with popular torrent clients:

docker-compose up

Web client info

README

Configuration

Web version

Configuration stored following locations:

Location Description
$HOME/.rsbt/torrents.toml Current torrents
$HOME/.rsbt/download/ Default download path

CLI version

We use confy for configuration. Configuration is stored in toml format.