mathieuruellan/peerflix-server repository overview

⁠peerflix-server

Streaming torrent client for node.js with web ui.

Based on torrent-stream⁠, inspired by peerflix⁠.

⁠Usage

1. npm install -g peerflix-server
2. peerflix-server
3. Open your browser at http://localhost:9000/⁠
4. Enjoy!

⁠Configuration

You can configure the application using ~/.config/peerflix-server/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"
}

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

PORT=1234 peerflix-server

# or on windows
SET PORT=1234
peerflix-server

The application stores its current state (list of torrents) in ~/.config/peerflix-server/torrents.json

⁠Daemon

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

npm install -g forever

forever start $(which peerflix-server)

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

⁠FAQ

How do I add password protection?⁠

⁠Development

See Development.md⁠

⁠REST API

See REST.md⁠

⁠Docker

See Docker.md⁠