t-flix-server

Streaming torrent client for node.js with web ui.


Keywords
bittorrent, torrent, stream, t-flix, server, web, torrent-client, torrent-crawler, torrent-server
License
MIT
Install
npm install t-flix-server@1.0.0

Documentation

t-flix-server

logo

Streaming torrent client for node.js with web ui.

screen capture

Based on torrent-stream, inspired by PeerFlix.

Usage

  1. git clone https://github.com/Inside4ndroid/t-flix.git
  2. npm install -g
  3. t-flix-server
  4. Open your browser at http://localhost:9000/
  5. Enjoy!

Configuration

You can configure the application using config.json file (doesn't exist by default). The options are passed to all torrent-stream instances. Here's an example that overrides the defaults:

{
  "connections": 50,
  "tmp": "/mnt/torrents"
}

The application stores its current state (list of torrents) in torrents.json

You can define configuration and state files location by t-flix_CONFIG_PATH environmnt variable. Default value is $HOME/.config/t-flix-server/.

You can also change the default port by setting PORT environment variable:

PORT=1234 t-flix-server

# or on windows
SET PORT=1234
t-flix-server

Daemon

If you want to run t-flix-server as a daemon, you can do it using forever:

npm install -g forever
forever start $(which t-flix-server)

You might also want to enable logging -- see the docs.

FAQ

How to put NCSA Auth password on peerflix server

How to put a password on peerflix server using basic auth

Development

See Development.md

REST API

See REST.md