TorrServer

https://github.com/yourok/torrserver
Admin
TorrServer is a tool for streaming torrents online without downloading, featuring caching, HTTP...
Tokens:12,486
Snippets:138
Trust Score:7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Run TorrServer with Custom Arguments

Source: https://github.com/yourok/torrserver/blob/master/docker/lite/README.md

Example of starting the container with a specific version tag and custom port argument.

```bash
docker run -p 8099:8099 yourok/torrlite:MatriX.134 --port=8099
```

--------------------------------

### Start TorrServer Web Client

Source: https://github.com/yourok/torrserver/blob/master/web/README.md

Follow these steps to start the project. Ensure the server address in `.env` does not end with a '/'.

```bash
NODE_OPTIONS=--openssl-legacy-provider yarn start
```

--------------------------------

### TorrServer Command-Line Arguments Example

Source: https://github.com/yourok/torrserver/blob/master/README.md

Illustrative example of how to invoke TorrServer with various command-line arguments for configuration.

```bash
TorrServer-darwin-arm64 [--port PORT] [--ip IP] [--path PATH] [--logpath LOGPATH] [--weblogpath WEBLOGPATH] [--rdb] [--httpauth] [--dontkill] [--ui] [--torrentsdir TORRENTSDIR] [--torrentaddr TORRENTADDR] [--pubipv4 PUBIPV4] [--pubipv6 PUBIPV6] [--searchwa] [--maxsize MAXSIZE] [--tg TGTOKEN] [--fuse FUSEPATH] [--webdav]
```

--------------------------------

### Install TorrServer on macOS

Source: https://github.com/yourok/torrserver/blob/master/README.md

Use this command to download, make executable, and run the installation script for TorrServer on macOS.

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

--------------------------------

### Display TorrServer Installation Script Help Message

Source: https://github.com/yourok/torrserver/blob/master/README.md

Shows the help message for the TorrServer installation script, listing all available commands and their descriptions.

```bash
sudo bash ./installTorrServerLinux.sh --help
```

--------------------------------

### Run Development Servers

Source: https://github.com/yourok/torrserver/blob/master/README.md

Commands to start the Go backend or the web frontend locally.

```bash
cd server
go run ./cmd
```

```bash
yarn start
```

--------------------------------

### Run with Command Line Options

Source: https://context7.com/yourok/torrserver/llms.txt

Basic execution example using command-line arguments for port and path configuration.

```bash
# Basic usage
./TorrServer --port 8090 --path /data/torrserver
```

--------------------------------

### Configure Authentication

Source: https://context7.com/yourok/torrserver/llms.txt

Setup for HTTP Basic Authentication using an accs.db file and command-line flags.

```json
// accs.db - place in config directory
{
  "admin": "secretpassword",
  "user1": "password123"
}
```

```bash
# Start server with authentication enabled
./TorrServer -a -d /path/to/config

# Make authenticated requests
curl -u admin:secretpassword http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{"action": "list"}'
```

--------------------------------

### Install TorrServer on Linux

Source: https://github.com/yourok/torrserver/blob/master/README.md

Use this script to install, update, reconfigure, or uninstall TorrServer on Linux systems. It supports interactive and silent modes.

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

--------------------------------

### Get TorrServer Settings

Source: https://context7.com/yourok/torrserver/llms.txt

Retrieve the current server configuration using the /settings endpoint with action: "get".

```bash
# Get current settings
curl -X POST http://127.0.0.1:8090/settings \
  -H "Content-Type: application/json" \
  -d '{"action": "get"}'
```

--------------------------------

### Configure IP Whitelist/Blacklist

Source: https://github.com/yourok/torrserver/blob/master/README.md

Example format for wip.txt or bip.txt files to control access by IP range.

```text
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
```

--------------------------------

### GET /echo

Source: https://context7.com/yourok/torrserver/llms.txt

Tests if the server is running and returns the current version.

```APIDOC
## GET /echo

### Description
Checks server status and returns the version string.

### Method
GET

### Endpoint
/echo

### Response
#### Success Response (200)
- **version** (string) - The server version string (e.g., "MatriX.141")
```

--------------------------------

### Rebuild Swagger Documentation

Source: https://github.com/yourok/torrserver/blob/master/README.md

Install the swag tool and regenerate API documentation from source code.

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

# Documentation can be linted using
swag fmt
```

--------------------------------

### Run TorrServer Container

Source: https://github.com/yourok/torrserver/blob/master/docker/lite/README.md

Basic command to start the TorrServer container with port mapping.

```bash
docker run -p 8090:8090 yourok/torrlite:TAG [ ARGS ]
```

--------------------------------

### TorrServer Telegram Bot Configuration Example

Source: https://github.com/yourok/torrserver/blob/master/server/tgbot/README.md

Example JSON configuration for the `tg.cfg` file, specifying Telegram API URL, stream link base URL, and allowed/blocked user IDs.

```json
{
  "HostTG": "https://api.telegram.org",
  "HostWeb": "http://192.168.1.100:8090",
  "WhiteIds": [123456789],
  "BlackIds": []
}
```

--------------------------------

### Run via Docker CLI

Source: https://context7.com/yourok/torrserver/llms.txt

Commands to start the TorrServer container with standard or custom environment variables.

```bash
# Run with Docker CLI
docker run --rm -d \
  --name torrserver \
  -v ~/ts:/opt/ts \
  -p 8090:8090 \
  ghcr.io/yourok/torrserver:latest

# Run with environment variables
docker run --rm -d \
  -e TS_PORT=5665 \
  -e TS_DONTKILL=1 \
  -e TS_HTTPAUTH=1 \
  --name torrserver \
  -v ~/ts:/opt/ts \
  -p 5665:5665 \
  ghcr.io/yourok/torrserver:latest
```

--------------------------------

### Install Specific TorrServer Version Silently

Source: https://github.com/yourok/torrserver/blob/master/README.md

Installs a specific version of TorrServer in non-interactive mode. Ensure you have the correct version number.

```bash
sudo bash ./installTorrServerLinux.sh --install 135 --silent
```

--------------------------------

### Download and Set Execute Permissions for TorrServer Script

Source: https://github.com/yourok/torrserver/blob/master/README.md

Download the installation script and set execute permissions before running it. This ensures the script can be executed on your system.

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

--------------------------------

### Run TorrServer in Docker with Environment Variables

Source: https://github.com/yourok/torrserver/blob/master/README.md

Example Docker command demonstrating the use of environment variables to configure TorrServer, including port, authentication, logging, and proxy settings.

```bash
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 -e TS_PROXYURL=socks5h://user:password@example.com:2080 -e TS_PROXYMODE=tracker --name torrserver -v ~/ts:/opt/ts -p 5665:5665 ghcr.io/yourok/torrserver:latest
```

--------------------------------

### GET /download/{size}

Source: https://context7.com/yourok/torrserver/llms.txt

Generates a test file of a specified size for speed testing.

```APIDOC
## GET /download/{size}

### Description
Generates a test file of the specified size in MB.

### Method
GET

### Endpoint
/download/{size}

### Parameters
#### Path Parameters
- **size** (integer) - Required - Size of the test file in MB.
```

--------------------------------

### Run TorrServer with Docker CLI

Source: https://github.com/yourok/torrserver/blob/master/docker/README.md

Use this command to start a TorrServer container with custom environment variables for port, paths, and authentication.

```bash
docker run -p 8090:8090 \
-e TS_PORT=8090 \
-e TS_PATH="/opt/torrserver/config" \
-e TS_LOGPATHDIR="/opt/torrserver/log/" \
-e TS_LOGFILE="ts.log" \
-e TS_WEBLOGFILE="tsweb.log" \
-e TS_RDB=true \
-e TS_HTTPAUTH=true \
-e TS_DONTKILL=true \
-e TS_TORRENTSDIR="/opt/torrserver/torrents" \
-e TS_TORRENTADDR=32000 \
-e TS_PUBIPV4=publicIP \
-e TS_PUBIPV6=publicIP \
-e TS_SEARCHWA=true \
yourok/torrserver
```

--------------------------------

### GET /shutdown

Source: https://context7.com/yourok/torrserver/llms.txt

Gracefully shuts down the server after a 1-second delay.

```APIDOC
## GET /shutdown

### Description
Initiates a graceful shutdown of the server.

### Method
GET

### Endpoint
/shutdown
```

--------------------------------

### Retrieve Media Information

Source: https://context7.com/yourok/torrserver/llms.txt

Get detailed ffprobe output for a specific file within a torrent.

```bash
# Get media info for file
curl "http://127.0.0.1:8090/ffp/08ada5a7a6183aae1e09d831df6748d566095a10/1"
```

--------------------------------

### Generate M3U Playlist from Last Viewed

Source: https://context7.com/yourok/torrserver/llms.txt

Generate an M3U playlist starting from the last viewed file for a torrent. Use the 'fromlast=true' parameter.

```bash
# Get M3U starting from last viewed file
curl "http://127.0.0.1:8090/playlist?hash=08ada5a7a6183aae1e09d831df6748d566095a10&fromlast=true"
```

--------------------------------

### GET /playlist

Source: https://context7.com/yourok/torrserver/llms.txt

Generates M3U playlists for media players.

```APIDOC
## GET /playlist

### Description
Generates an M3U playlist for a specific torrent or all torrents.

### Method
GET

### Endpoint
/playlist

### Parameters
#### Query Parameters
- **hash** (string) - Required - The torrent hash
- **fromlast** (boolean) - Optional - Start from last viewed file
```

--------------------------------

### Get Torrent Cache Statistics

Source: https://context7.com/yourok/torrserver/llms.txt

Retrieve detailed cache statistics for a specific torrent using the /cache endpoint with action: "get". Requires the torrent's hash.

```bash
# Get cache stats for torrent
curl -X POST http://127.0.0.1:8090/cache \
  -H "Content-Type: application/json" \
  -d '{"action": "get", "hash": "08ada5a7a6183aae1e09d831df6748d566095a10"}'
```

--------------------------------

### GET /ffp/{hash}/{id}

Source: https://context7.com/yourok/torrserver/llms.txt

Returns detailed media information using ffprobe for a specific file in a torrent.

```APIDOC
## GET /ffp/{hash}/{id}

### Description
Retrieves media metadata for a specific file within a torrent.

### Method
GET

### Endpoint
/ffp/{hash}/{id}

### Parameters
#### Path Parameters
- **hash** (string) - Required - The torrent info hash.
- **id** (string) - Required - The file ID within the torrent.

### Response
#### Success Response (200)
- **data** (object) - ffprobe JSON output containing streams, format, duration, and codecs.
```

--------------------------------

### Enable TorrServer with Telegram Bot Token

Source: https://github.com/yourok/torrserver/blob/master/server/tgbot/README.md

Start the TorrServer application with your Telegram bot token to enable the bot functionality. This can be done using the `--tg` or `-T` flags.

```bash
TorrServer --tg YOUR_BOT_TOKEN
```

```bash
TorrServer -T YOUR_BOT_TOKEN
```

--------------------------------

### GET /search and /torznab/search

Source: https://context7.com/yourok/torrserver/llms.txt

Search for torrents using Rutor or Torznab indexers. Requires search to be enabled in settings.

```APIDOC
## GET /search
## GET /torznab/search

### Description
Searches for torrents using configured indexers.

### Method
GET

### Endpoint
/search or /torznab/search

### Parameters
#### Query Parameters
- **query** (string) - Required - The search term to look for.

### Response
#### Success Response (200)
- **name** (string) - Torrent title
- **hash** (string) - Torrent info hash
- **magnet** (string) - Magnet link
- **link** (string) - Source link
- **size** (string) - Torrent size
- **seed** (integer) - Number of seeders
- **peer** (integer) - Number of peers
- **createDate** (string) - Creation date
- **categories** (string) - Torrent category
- **videoQuality** (integer) - Video quality resolution
- **year** (integer) - Release year

#### Response Example
[
  {
    "name": "Sintel (2010) 1080p",
    "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
    "magnet": "magnet:?xt=urn:btih:08ada5a7...",
    "link": "https://rutor.info/torrent/...",
    "size": "129 MB",
    "seed": 150,
    "peer": 25,
    "createDate": "2024-01-15",
    "categories": "Movies",
    "videoQuality": 1080,
    "year": 2010
  }
]
```

--------------------------------

### Check for TorrServer Updates

Source: https://github.com/yourok/torrserver/blob/master/README.md

Checks for available updates for TorrServer and displays version information without performing an installation or update.

```bash
sudo bash ./installTorrServerLinux.sh --check
```

--------------------------------

### Torrents API - Manage Torrents

Source: https://context7.com/yourok/torrserver/llms.txt

The /torrents endpoint handles all torrent management operations including adding, listing, getting, setting, removing, dropping, and wiping torrents. Use the `action` field to specify the operation.

```APIDOC
## POST /torrents

### Description
Manages torrents by performing actions like adding, listing, getting, setting, removing, dropping, and wiping.

### Method
POST

### Endpoint
/torrents

### Parameters
#### Request Body
- **action** (string) - Required - The operation to perform (e.g., `add`, `list`, `get`, `set`, `rem`, `drop`, `wipe`).
- **link** (string) - Optional - Magnet link or torrent URL (required for `add` action).
- **hash** (string) - Optional - Torrent hash (required for `get`, `set`, `rem`, `drop` actions).
- **title** (string) - Optional - Custom title for the torrent (used with `add` and `set` actions).
- **poster** (string) - Optional - URL for the torrent's poster image (used with `add` action).
- **category** (string) - Optional - Category for the torrent (used with `add` and `set` actions).
- **save_to_db** (boolean) - Optional - Whether to save the torrent to the database (used with `add` action).

### Request Example
```json
{
  "action": "add",
  "link": "magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel",
  "title": "Sintel Movie",
  "poster": "https://example.com/poster.jpg",
  "category": "movie",
  "save_to_db": true
}
```

### Response
#### Success Response (200)
- **TorrentStatus object** - Contains details about the torrent, including hash, name, status, file statistics, etc.

#### Response Example
```json
{
  "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
  "name": "Sintel Movie",
  "stat": 1,
  "stat_string": "Torrent working",
  "loaded_size": 0,
  "torrent_size": 129241752,
  "download_speed": 0,
  "active_peers": 0,
  "file_stats": [
    {
      "id": 0,
      "path": "Sintel.mp4",
      "length": 129241752
    }
  ]
}
```
```

--------------------------------

### Update TorrServer to Latest Version Silently

Source: https://github.com/yourok/torrserver/blob/master/README.md

Updates TorrServer to the latest available version using a non-interactive command. This is a convenient way to keep your installation up-to-date.

```bash
sudo bash ./installTorrServerLinux.sh --update --silent
```

--------------------------------

### Stream API - Multi-Purpose Streaming Endpoint

Source: https://context7.com/yourok/torrserver/llms.txt

The /stream endpoint is a versatile endpoint for streaming torrents, getting statistics, generating M3U playlists, and saving torrents.

```APIDOC
## GET /stream

### Description
Provides versatile streaming, statistics, M3U playlist generation, and torrent saving functionalities.

### Method
GET

### Endpoint
/stream

### Parameters
#### Query Parameters
- **link** (string) - Required - Magnet URI or torrent hash.
- **index** (integer) - Optional - The index of the file to stream.
- **play** (boolean) - Optional - If true, starts streaming the content.
- **m3u** (boolean) - Optional - If true, generates an M3U playlist.
- **stat** (boolean) - Optional - If true, returns torrent statistics.
- **save** (boolean) - Optional - If true, persists the torrent to the database.
- **fromlast** (boolean) - Optional - If true, generates M3U starting from the last played file.
- **title** (string) - Optional - Custom title for the torrent (used with `save` action).
- **poster** (string) - Optional - URL for the torrent's poster image (used with `save` action).
- **category** (string) - Optional - Category for the torrent (used with `save` action).

### Request Example
```bash
# Stream a specific file from torrent (index 1)
curl "http://127.0.0.1:8090/stream/movie.mp4?link=magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&index=1&play"

# Get torrent statistics
curl "http://127.0.0.1:8090/stream?link=08ada5a7a6183aae1e09d831df6748d566095a10&stat"

# Generate M3U playlist for torrent
curl "http://127.0.0.1:8090/stream/playlist.m3u?link=08ada5a7a6183aae1e09d831df6748d566095a10&m3u"

# Stream with preload and save to database
curl "http://127.0.0.1:8090/stream/movie.mp4?link=magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&index=1&play&preload&save&title=My%20Movie&poster=https://example.com/poster.jpg&category=movie"
```

### Response
#### Success Response (200)
- **Stream data** - For streaming requests.
- **Torrent statistics object** - For `stat` requests.
- **M3U playlist content** - For `m3u` requests.

#### Response Example (Statistics)
```json
{
  "title": "Sintel",
  "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
  "stat": 3,
  "stat_string": "Torrent working",
  "loaded_size": 52428800,
  "torrent_size": 129241752,
  "download_speed": 2456789.5,
  "active_peers": 15,
  "file_stats": [
    {
      "id": 1,
      "path": "Sintel.mp4",
      "length": 129241752
    }
  ]
}
```
```

--------------------------------

### Apply Preset with Multiple Key-Value Pairs

Source: https://github.com/yourok/torrserver/blob/master/server/tgbot/README.md

Apply a named preset or set multiple configuration keys with their values using the `/preset` command. This allows for fine-grained control over server settings like cache size, preload percentage, and connection limits.

```bash
/preset cache 256 preload 50
```

```bash
/preset cache 512 conn 100 down 0 up 0
```

--------------------------------

### Build Web Frontend

Source: https://github.com/yourok/torrserver/blob/master/README.md

Build command for the web interface requiring legacy OpenSSL provider.

```bash
NODE_OPTIONS=--openssl-legacy-provider yarn build
```

--------------------------------

### POST /settings

Source: https://context7.com/yourok/torrserver/llms.txt

Manages server configuration settings including cache, limits, and network options.

```APIDOC
## POST /settings

### Description
Retrieves, updates, or resets server configuration settings.

### Method
POST

### Endpoint
/settings

### Parameters
#### Request Body
- **action** (string) - Required - Action to perform: "get", "set", or "def"
- **sets** (object) - Optional - Configuration object for "set" action
```

--------------------------------

### Mark File as Viewed

Source: https://context7.com/yourok/torrserver/llms.txt

Use the /viewed endpoint with action: "set" to track watched content. Requires torrent hash and file index.

```bash
# Mark file as viewed (file_index starts from 1)
curl -X POST http://127.0.0.1:8090/viewed \
  -H "Content-Type: application/json" \
  -d '{
    "action": "set",
    "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
    "file_index": 1
  }'
```

--------------------------------

### Perform Speed Test

Source: https://context7.com/yourok/torrserver/llms.txt

Generate a test file of a specific size in MB to measure download speed.

```bash
# Download 10MB test file
curl -o testfile.bin "http://127.0.0.1:8090/download/10"
```

--------------------------------

### Reconfigure TorrServer Settings Interactively

Source: https://github.com/yourok/torrserver/blob/master/README.md

Launches an interactive prompt to reconfigure TorrServer settings such as port, authentication, read-only mode, logging, and BBR.

```bash
sudo bash ./installTorrServerLinux.sh --reconfigure
```

--------------------------------

### Check Server Health

Source: https://context7.com/yourok/torrserver/llms.txt

Verify the server is running and retrieve the version string.

```bash
# Check server status
curl http://127.0.0.1:8090/echo
```

--------------------------------

### Shutdown Server

Source: https://context7.com/yourok/torrserver/llms.txt

Initiate a graceful server shutdown with a 1-second delay.

```bash
# Shutdown server
curl http://127.0.0.1:8090/shutdown
```

--------------------------------

### Deploy TorrServer with Docker Compose

Source: https://github.com/yourok/torrserver/blob/master/docker/README.md

Use this configuration file to deploy TorrServer with persistent volumes and defined environment settings.

```yaml
version: '3.6'
services:
  torrserver:
    container_name: torrserver
    image: ghcr.io/yourok/torrserver
    restart: unless-stopped
    environment:
      - TS_PORT=8090
      - TS_PATH=/opt/torrserver/config
      - TS_LOGPATHDIR=/opt/torrserver/log
      - TS_LOGFILE=ts.log
      - TS_WEBLOGFILE=tsweb.log
      - TS_RDB=false
      - TS_HTTPAUTH=true
      - TS_DONTKILL=true
      - TS_TORRENTSDIR=/opt/torrserver/torrents
      - TS_TORRENTADDR=:32000
      - TS_PUBIPV4=publicIP
      - TS_PUBIPV6=publicIP
      - TS_SEARCHWA=true
    ports:
      - 8090:8090
    volumes:
      - ./torrserver/config:/opt/torrserver/config
      - ./torrserver/log:/opt/torrserver/log
      - ./torrserver/torrents:/opt/torrserver/torrents
```

--------------------------------

### Initialize Firebase for TorrServer

Source: https://github.com/yourok/torrserver/blob/master/web/public/index.html

Configure and initialize Firebase with your project's specific configuration details. Ensure JavaScript is enabled to run this app.

```javascript
const firebaseConfig = { apiKey: "AIzaSyDivIsadtzAmp3SIY4yArNcFugUmr63rvo", authDomain: "torrserve.firebaseapp.com", databaseURL: "https://torrserve.firebaseio.com", projectId: "torrserve", storageBucket: "torrserve.appspot.com", messagingSenderId: "400168070412", appId: "1:400168070412:web:82c8e43dd7fc8f807aed29", measurementId: "G-T4RC2BFRSF" }; firebase.initializeApp(firebaseConfig); firebase.analytics();
```

--------------------------------

### Generate M3U Playlist for All Torrents

Source: https://context7.com/yourok/torrserver/llms.txt

Generate a single M3U playlist containing all available torrents using the /playlistall/all.m3u endpoint.

```bash
# Get M3U playlist containing all torrents
curl "http://127.0.0.1:8090/playlistall/all.m3u"
```

--------------------------------

### Run TorrServer in Docker with Persistence

Source: https://github.com/yourok/torrserver/blob/master/README.md

Docker command to run TorrServer with a persistent volume mounted for configuration and data.

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

--------------------------------

### Reset TorrServer Settings to Defaults

Source: https://context7.com/yourok/torrserver/llms.txt

Reset all server configurations to their default values using the /settings endpoint with action: "def".

```bash
# Reset to default settings
curl -X POST http://127.0.0.1:8090/settings \
  -H "Content-Type: application/json" \
  -d '{"action": "def"}'
```

--------------------------------

### Stream Content via /stream API

Source: https://context7.com/yourok/torrserver/llms.txt

Use the /stream endpoint to initiate playback, retrieve statistics, or generate M3U playlists.

```bash
# Stream a specific file from torrent (index 1)
curl "http://127.0.0.1:8090/stream/movie.mp4?link=magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&index=1&play"

# Get torrent statistics
curl "http://127.0.0.1:8090/stream?link=08ada5a7a6183aae1e09d831df6748d566095a10&stat"

# Response example:
# {
#   "title": "Sintel",
#   "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
#   "stat": 3,
#   "stat_string": "Torrent working",
#   "loaded_size": 52428800,
#   "torrent_size": 129241752,
#   "download_speed": 2456789.5,
#   "active_peers": 15,
#   "file_stats": [{"id": 1, "path": "Sintel.mp4", "length": 129241752}]
# }

# Generate M3U playlist for torrent
curl "http://127.0.0.1:8090/stream/playlist.m3u?link=08ada5a7a6183aae1e09d831df6748d566095a10&m3u"

# Generate M3U starting from last played file
curl "http://127.0.0.1:8090/stream/playlist.m3u?link=08ada5a7a6183aae1e09d831df6748d566095a10&m3u&fromlast"

# Stream with preload and save to database
curl "http://127.0.0.1:8090/stream/movie.mp4?link=magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&index=1&play&preload&save&title=My%20Movie&poster=https://example.com/poster.jpg&category=movie"
```

--------------------------------

### Deploy with Docker Compose

Source: https://context7.com/yourok/torrserver/llms.txt

Configuration for running TorrServer using Docker Compose with host networking for DLNA support.

```yaml
# docker-compose.yml
version: '3.3'
services:
  torrserver:
    image: ghcr.io/yourok/torrserver:latest
    container_name: torrserver
    network_mode: host  # Required for DLNA
    environment:
      - TS_PORT=8090
      - TS_DONTKILL=1
      - TS_HTTPAUTH=0
      - TS_RDB=0
      - TS_CONF_PATH=/opt/ts/config
      - TS_TORR_DIR=/opt/ts/torrents
      - TS_LOG_PATH=/opt/ts/log
      - TS_PROXYURL=socks5h://user:pass@proxy.example.com:1080
      - TS_PROXYMODE=tracker
    volumes:
      - './cache:/opt/ts/torrents'
      - './config:/opt/ts/config'
    ports:
      - '8090:8090'
    restart: unless-stopped
```

--------------------------------

### ESLint Commands

Source: https://github.com/yourok/torrserver/blob/master/web/README.md

Use these commands to manage code linting and formatting with ESLint and Prettier.

```bash
yarn lint
```

```bash
yarn fix
```

--------------------------------

### Play API - Direct File Streaming

Source: https://context7.com/yourok/torrserver/llms.txt

The /play/{hash}/{id} endpoint provides direct streaming of a specific file from a torrent using the infohash and file index.

```APIDOC
## GET /play/{hash}/{id}

### Description
Directly streams a specific file from a torrent using its infohash and file index.

### Method
GET

### Endpoint
/play/{hash}/{id}

### Parameters
#### Path Parameters
- **hash** (string) - Required - The infohash of the torrent.
- **id** (integer) - Required - The index of the file to stream within the torrent.

### Request Example
```bash
# Stream file with index 1 from torrent
curl -o output.mp4 "http://127.0.0.1:8090/play/08ada5a7a6183aae1e09d831df6748d566095a10/1"
```

### Response
#### Success Response (200)
- **File stream data** - The content of the requested file.
```

--------------------------------

### Initialize Firebase and Webpack Runtime

Source: https://github.com/yourok/torrserver/blob/master/server/web/pages/template/pages/index.html

Contains the Firebase configuration object and the minified Webpack runtime loader for the application.

```javascript
const firebaseConfig={apiKey:"AIzaSyDivIsadtzAmp3SIY4yArNcFugUmr63rvo",authDomain:"torrserve.firebaseapp.com",databaseURL:"https://torrserve.firebaseio.com",projectId:"torrserve",storageBucket:"torrserve.appspot.com",messagingSenderId:"400168070412",appId:"1:400168070412:web:82c8e43dd7fc8f807aed29",measurementId:"G-T4RC2BFRSF"};firebase.initializeApp(firebaseConfig),firebase.analytics()!function(e){function r(r){for(var n,l,f=r[0],i=r[1],a=r[2],c=0,s=[];c<f.length;c++)l=f[c],Object.prototype.hasOwnProperty.call(o,l)&&o[l]&&s.push(o[l][0]),o[l]=0;for(n in i)Object.prototype.hasOwnProperty.call(i,n)&&(e[n]=i[n]);for(p&&p(r);s.length;)s.shift()();return u.push.apply(u,a||[]),t()}function t(){for(var e,r=0;r<u.length;r++){for(var t=u[r],n=!0,f=1;f<t.length;f++){var i=t[f];0!==o[i]&&(n=!1)}n&&(u.splice(r--,1),e=l(l.s=t[0]))}return e}var n={},o={1:0},u=[];function l(r){if(n[r])return n[r].exports;var t=n[r]={i:r,l:!1,exports:{}};return e[r].call(t.exports,t,t.exports,l),t.l=!0,t.exports}l.m=e,l.c=n,l.d=function(e,r,t){l.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},l.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},l.t=function(e,r){if(1&r&&(e=l(e)),8&r)return e;if(4&r&&"object"==typeof e&&e&&e.__esModule)return e;var t=Object.create(null);if(l.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:e}),2&r&&"string"!=typeof e)for(var n in e)l.d(t,n,function(r){return e[r]}.bind(null,n));return t},l.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return l.d(r,"a",r),r},l.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},l.p="./";var f=this.webpackJsonptorrserver_web=this.webpackJsonptorrserver_web||[],i=f.push.bind(f);f.push=r,f=f.slice();for(var a=0;a<f.length;a++)r(f[a]);var p=i;t()}([])
```

--------------------------------

### Generate M3U Playlist for a Torrent

Source: https://context7.com/yourok/torrserver/llms.txt

Generate an M3U playlist for a specific torrent using the /playlist endpoint. Useful for media players.

```bash
# Get M3U playlist for specific torrent
curl "http://127.0.0.1:8090/playlist?hash=08ada5a7a6183aae1e09d831df6748d566095a10"
```

--------------------------------

### List Viewed Files for a Torrent

Source: https://context7.com/yourok/torrserver/llms.txt

Retrieve a list of all viewed files for a specific torrent using the /viewed endpoint with action: "list".

```bash
# List all viewed files for a torrent
curl -X POST http://127.0.0.1:8090/viewed \
  -H "Content-Type: application/json" \
  -d '{"action": "list", "hash": "08ada5a7a6183aae1e09d831df6748d566095a10"}'
```

--------------------------------

### Generate PWA Assets

Source: https://github.com/yourok/torrserver/blob/master/web/README.md

This command generates Progressive Web App assets using `pwa-asset-generator`. Configure the background and image position as needed.

```bash
npx pwa-asset-generator public/logo.png public -m public/site.webmanifest -p "calc(50vh - 25%) calc(50vw - 25%)" -b "linear-gradient(135deg, rgb(50,50,55), rgb(84,90,94))" -q 100 -i public/index.html -f
```

--------------------------------

### Configure TorrServer with Docker Compose

Source: https://github.com/yourok/torrserver/blob/master/README.md

Use this configuration to deploy TorrServer as a container with persistent volumes and network host mode.

```yaml
version: '3.3'
services:
    torrserver:
        image: ghcr.io/yourok/torrserver
        container_name: torrserver
        network_mode: host    # to allow DLNA feature
        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
```

--------------------------------

### Run TorrServer Service as Root User

Source: https://github.com/yourok/torrserver/blob/master/README.md

Configures the TorrServer service to run with root privileges. This option should be used carefully due to security implications.

```bash
sudo bash ./installTorrServerLinux.sh --root
```

--------------------------------

### POST /torrent/upload

Source: https://context7.com/yourok/torrserver/llms.txt

Uploads a .torrent file to the server with optional metadata.

```APIDOC
## POST /torrent/upload

### Description
Uploads a .torrent file via multipart form data. Supports optional metadata like title, category, and poster.

### Method
POST

### Endpoint
/torrent/upload

### Parameters
#### Request Body
- **file** (binary) - Required - The .torrent file to upload
- **save** (boolean) - Optional - Whether to save to database
- **title** (string) - Optional - Title of the torrent
- **category** (string) - Optional - Category of the torrent
- **poster** (string) - Optional - URL to the poster image

### Response
#### Success Response (200)
- **title** (string) - Torrent title
- **category** (string) - Torrent category
- **poster** (string) - Poster URL
- **hash** (string) - Torrent hash
- **stat** (integer) - Status code
- **stat_string** (string) - Status message
```

--------------------------------

### POST /cache

Source: https://context7.com/yourok/torrserver/llms.txt

Retrieves detailed cache statistics for a specific torrent.

```APIDOC
## POST /cache

### Description
Returns cache statistics including piece states and reader positions for a given torrent hash.

### Method
POST

### Endpoint
/cache

### Parameters
#### Request Body
- **action** (string) - Required - Action to perform: "get"
- **hash** (string) - Required - The torrent hash
```

--------------------------------

### Stream Files via /play API

Source: https://context7.com/yourok/torrserver/llms.txt

Directly stream a specific file from a torrent using its hash and file index.

```bash
# Stream file with index 1 from torrent
curl -o output.mp4 "http://127.0.0.1:8090/play/08ada5a7a6183aae1e09d831df6748d566095a10/1"
```

--------------------------------

### Run TorrServer in Docker

Source: https://github.com/yourok/torrserver/blob/master/README.md

Basic Docker command to run TorrServer in detached mode, mapping port 8090.

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

--------------------------------

### Download Specific Files via Reply

Source: https://github.com/yourok/torrserver/blob/master/server/tgbot/README.md

Reply to a file list with a range of numbers (e.g., '2-12') to download those specific files to Telegram.

```bash
2-12
```

--------------------------------

### Upload Torrent File via API

Source: https://context7.com/yourok/torrserver/llms.txt

Upload a .torrent file to TorrServer using the /torrent/upload endpoint. Supports optional metadata for better organization.

```bash
# Upload a .torrent file
curl -X POST http://127.0.0.1:8090/torrent/upload \
  -F "file=@/path/to/movie.torrent" \
  -F "save=true" \
  -F "title=My Movie" \
  -F "category=movie" \
  -F "poster=https://example.com/poster.jpg"
```

--------------------------------

### POST /viewed

Source: https://context7.com/yourok/torrserver/llms.txt

Tracks viewing history for files within a torrent.

```APIDOC
## POST /viewed

### Description
Manages viewing history by marking files as watched, removing them, or listing history.

### Method
POST

### Endpoint
/viewed

### Parameters
#### Request Body
- **action** (string) - Required - Action to perform: "set", "rem", or "list"
- **hash** (string) - Required - The torrent hash
- **file_index** (integer) - Optional - Index of the file (starts from 1)
```

--------------------------------

### Search Torrents via API

Source: https://context7.com/yourok/torrserver/llms.txt

Search for torrents using Rutor or Torznab indexers. Requires search to be enabled in server settings.

```bash
# Search using Rutor indexer
curl "http://127.0.0.1:8090/search?query=sintel"

# Search using Torznab indexers
curl "http://127.0.0.1:8090/torznab/search?query=sintel"
```

--------------------------------

### Play Torrent in VLC

Source: https://context7.com/yourok/torrserver/llms.txt

Use this URL to play a specific torrent in VLC or other compatible media players.

```bash
vlc "http://127.0.0.1:8090/play/08ada5a7a6183aae1e09d831df6748d566095a10/1"
```

--------------------------------

### Define User Authentication

Source: https://github.com/yourok/torrserver/blob/master/README.md

JSON format for the accs.db file used for basic authentication.

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

--------------------------------

### Inline Mode Search Query

Source: https://github.com/yourok/torrserver/blob/master/server/tgbot/README.md

When typing `@YourBotName` in any chat, providing 2 or more characters initiates a search across RuTor and Torznab indexers.

```bash
@botname search_query
```

--------------------------------

### Update TorrServer Settings

Source: https://context7.com/yourok/torrserver/llms.txt

Modify server settings by sending a JSON payload with action: "set" and a "sets" object to the /settings endpoint.

```bash
# Update settings
curl -X POST http://127.0.0.1:8090/settings \
  -H "Content-Type: application/json" \
  -d '{
    "action": "set",
    "sets": {
      "cacheSize": 134217728,
      "preloadCache": 75,
      "enableDLNA": true,
      "friendlyName": "TorrServer Living Room",
      "connectionsLimit": 50,
      "downloadRateLimit": 5000,
      "enableIPv6": true,
      "responsiveMode": true
    }
  }'
```

--------------------------------

### Manage Torrents via /torrents API

Source: https://context7.com/yourok/torrserver/llms.txt

Perform CRUD operations on torrents using the /torrents endpoint with JSON payloads.

```bash
# Add a torrent from magnet link
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{
    "action": "add",
    "link": "magnet:?xt=urn:btih:08ada5a7a6183aae1e09d831df6748d566095a10&dn=Sintel",
    "title": "Sintel Movie",
    "poster": "https://example.com/poster.jpg",
    "category": "movie",
    "save_to_db": true
  }'

# Response: TorrentStatus object with hash, name, stat, file_stats, etc.

# List all torrents
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{"action": "list"}'

# Get specific torrent by hash
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{"action": "get", "hash": "08ada5a7a6183aae1e09d831df6748d566095a10"}'

# Update torrent metadata
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{
    "action": "set",
    "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
    "title": "Updated Title",
    "category": "tv"
  }'

# Remove torrent from database
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{"action": "rem", "hash": "08ada5a7a6183aae1e09d831df6748d566095a10"}'

# Drop torrent (stop and remove from memory, keep in DB)
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{"action": "drop", "hash": "08ada5a7a6183aae1e09d831df6748d566095a10"}'

# Wipe all torrents
curl -X POST http://127.0.0.1:8090/torrents \
  -H "Content-Type: application/json" \
  -d '{"action": "wipe"}'
```

--------------------------------

### Remove/Uninstall TorrServer Silently

Source: https://github.com/yourok/torrserver/blob/master/README.md

Uninstalls TorrServer from the system in a non-interactive mode. This command removes the application and its associated configurations.

```bash
sudo bash ./installTorrServerLinux.sh --remove --silent
```

--------------------------------

### Downgrade TorrServer to a Specific Version

Source: https://github.com/yourok/torrserver/blob/master/README.md

Downgrades TorrServer to a specified older version. Use with caution and ensure compatibility.

```bash
sudo bash ./installTorrServerLinux.sh --down 135
```

--------------------------------

### Change TorrServer Systemd Service User Silently

Source: https://github.com/yourok/torrserver/blob/master/README.md

Changes the user under which the TorrServer systemd service runs to 'root' or 'torrserver' in a non-interactive mode.

```bash
sudo bash ./installTorrServerLinux.sh --change-user root --silent
```

--------------------------------

### Remove Viewed Status for a File

Source: https://context7.com/yourok/torrserver/llms.txt

Remove the viewed status for a specific file of a torrent using the /viewed endpoint with action: "rem".

```bash
# Remove viewed status
curl -X POST http://127.0.0.1:8090/viewed \
  -H "Content-Type: application/json" \
  -d '{
    "action": "rem",
    "hash": "08ada5a7a6183aae1e09d831df6748d566095a10",
    "file_index": 1
  }'
```
Tokens:
Raw