Awesome

Introduction

TorrServer is a program that allows users to view torrents online without the need for preliminary file downloading. The core functionality of TorrServer includes caching torrents and subsequent data transfer via the HTTP protocol, allowing the cache size to be adjusted according to the system parameters and the user's internet connection speed.

Features

• Caching
• Streaming
• Local and Remote Server
• Viewing torrents on various devices
• Integration with other apps through API
• Cross-browser modern web interface
• Optional DLNA server

Getting Started

Installation

Download the application for the required platform in the releases page. After installation, open the link http://127.0.0.1:8090 in the browser.

Windows

Run TorrServer-windows-amd64.exe.

Linux

Run in console

curl -s https://raw.githubusercontent.com/YouROK/TorrServer/master/installTorrServerLinux.sh | sudo bash

macOS

Run in Terminal.app

curl -s https://raw.githubusercontent.com/YouROK/TorrServer/master/installTorrServerMac.sh -o installTorrserverMac.sh && chmod 755 installTorrServerMac.sh && bash ./installTorrServerMac.sh

Alternative install script for Intel Macs: https://github.com/dancheskus/TorrServerMacInstaller

IOCage Plugin (Unofficial)

On FreeBSD (TrueNAS/FreeNAS) you can use this plugin: https://github.com/filka96/iocage-plugin-TorrServer

NAS Systems (Unofficial)

• Several releases are available through this link: https://github.com/vladlenas
• Synology NAS packages repo source: https://grigi.lt

Server args

• --port PORT, -p PORT - web server port (default 8090)
• --ssl - enables https for web server
• --sslport PORT - web server https port (default 8091). If not set, will be taken from db (if stored previously) or the default will be used.
• --sslcert PATH - path to ssl cert file. If not set, will be taken from db (if stored previously) or default self-signed certificate/key will be generated.
• --sslkey PATH - path to ssl key file. If not set, will be taken from db (if stored previously) or default self-signed certificate/key will be generated.
• --path PATH, -d PATH - database and config dir path
• --logpath LOGPATH, -l LOGPATH - server log file path
• --weblogpath WEBLOGPATH, -w WEBLOGPATH - web access log file path
• --rdb, -r - start in read-only DB mode
• --httpauth, -a - enable http auth on all requests
• --dontkill, -k - don't kill server on signal
• --ui, -u - open torrserver page in browser
• --torrentsdir TORRENTSDIR, -t TORRENTSDIR - autoload torrents from dir
• --torrentaddr TORRENTADDR - Torrent client address (format [IP]:PORT, ex. :32000, 127.0.0.1:32768 etc)
• --pubipv4 PUBIPV4, -4 PUBIPV4 - set public IPv4 addr
• --pubipv6 PUBIPV6, -6 PUBIPV6 - set public IPv6 addr
• --searchwa, -s - allow search without authentication
• --help, -h - display this help and exit
• --version - display version and exit

Example:

TorrServer-darwin-arm64 [--port PORT] [--path PATH] [--logpath LOGPATH] [--weblogpath WEBLOGPATH] [--rdb] [--httpauth] [--dontkill] [--ui] [--torrentsdir TORRENTSDIR] [--torrentaddr TORRENTADDR] [--pubipv4 PUBIPV4] [--pubipv6 PUBIPV6] [--searchwa]

Running in Docker & Docker Compose

Run in console

docker run --rm -d --name torrserver -p 8090:8090 ghcr.io/yourok/torrserver:latest

For running in persistence mode, just mount volume to container by adding -v ~/ts:/opt/ts, where ~/ts folder path is just example, but you could use it anyway... Result example command:

docker run --rm -d --name torrserver -v ~/ts:/opt/ts -p 8090:8090 ghcr.io/yourok/torrserver:latest

Environments

• TS_HTTPAUTH - 1, and place auth file into ~/ts/config folder for enabling basic auth
• TS_RDB - if 1, then the enabling --rdb flag
• TS_DONTKILL - if 1, then the enabling --dontkill flag
• TS_PORT - for changind default port to 5555 (example), also u need to change -p 8090:8090 to -p 5555:5555 (example)
• TS_CONF_PATH - for overriding torrserver config path inside container. Example /opt/tsss
• TS_TORR_DIR - for overriding torrents directory. Example /opt/torr_files
• TS_LOG_PATH - for overriding log path. Example /opt/torrserver.log

Example with full overrided command (on default values):

docker run --rm -d -e TS_PORT=5665 -e TS_DONTKILL=1 -e TS_HTTPAUTH=1 -e TS_RDB=1 -e TS_CONF_PATH=/opt/ts/config -e TS_LOG_PATH=/opt/ts/log -e TS_TORR_DIR=/opt/ts/torrents --name torrserver -v ~/ts:/opt/ts -p 5665:5665 ghcr.io/yourok/torrserver:latest

Docker Compose

# docker-compose.yml

version: '3.3'
services:
    torrserver:
        image: ghcr.io/yourok/torrserver
        container_name: torrserver
        environment:
            - TS_PORT=5665
            - TS_DONTKILL=1
            - TS_HTTPAUTH=0
            - TS_CONF_PATH=/opt/ts/config
            - TS_TORR_DIR=/opt/ts/torrents
        volumes:
            - './CACHE:/opt/ts/torrents'
            - './CONFIG:/opt/ts/config'
        ports:
            - '5665:5665'
        restart: unless-stopped

Smart TV (using Media Station X)

1. Install Media Station X on your Smart TV (see platform support)

2. Open it and go to: Settings -> Start Parameter -> Setup

3. Enter current ip and port of the TorrServe(r), e.g. 127.0.0.1:8090

Development

Go server

To run the Go server locally, just run

cd server
go run ./cmd

Web development

To run the web server locally, just run

yarn start

More info at https://github.com/YouROK/TorrServer/tree/master/web#readme

Build

Server

• Install Golang 1.20+
• Go to the TorrServer source directory
• Run build script under linux or macOS build-all.sh

Web

• Install npm and yarn
• Go to the web directory
• Run NODE_OPTIONS=--openssl-legacy-provider yarn build

Android

To build an Android server you will need the Android Toolchain.

Swagger

swag must be installed on the system to [re]build Swagger documentation.

go install github.com/swaggo/swag/cmd/swag@latest
cd server; swag init -g web/server.go

# Documentation can be linted using
swag fmt

API

API Docs

API documentation is hosted as Swagger format available at path /swagger/index.html.

Authentication

The users data file should be located near to the settings. Basic auth, read more in wiki https://en.wikipedia.org/wiki/Basic_access_authentication.

accs.db in JSON format:

{
    "User1": "Pass1",
    "User2": "Pass2"
}

Note: You should enable authentication with -a (--httpauth) TorrServer startup option.

Whitelist/Blacklist IP

The lists file should be located in the same directory with config.db.

• Whitelist file name: wip.txt
• Blacklist file name: bip.txt

Whitelist has priority over everything else.

Example:

local:127.0.0.0-127.0.0.255
127.0.0.0-127.0.0.255
local:127.0.0.1
127.0.0.1
# at the beginning of the line, comment

Donate

• YooMoney
• SberBank Card: 5484 4000 2285 7839

Thanks to everyone who tested and helped

• anacrolix Matt Joiner
• tsynik
• dancheskus for react web GUI and PWA code
• kolsys for initial Media Station X support
• damiva for Media Station X code updates
• vladlenas for NAS builds
• Nemiroff Tw1cker
• spawnlmg SpAwN_LMG for testing
• TopperBG Dimitar Maznekov for Bulgarian web translation
• FaintGhost Zhang Yaowei for Simplified Chinese web translation
• Anton111111 Anton Potekhin for sleep on Windows fixes
• lieranderl Evgeni for adding SSL support code
• cocool97 for openapi API documentation and torrent categories
• shadeov for README improvements
• butaford Pavel for make docker file and scripts
• filimonic Alexey D. Filimonov
• leporel Viacheslav Evseev
• and others