peerflix-server

Streaming torrent client for Node.js with web ui.

Github stars Tracking Chart

peerflix-server

NPM Version
NPM Downloads
Node.js Version
Build Status

Streaming torrent client for node.js with web ui.

screen capture

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

Overview

Name With Ownerasapach/peerflix-server
Primary LanguageJavaScript
Program languageHTML (Language Count: 4)
Platform
License:MIT License
Release Count42
Last Release Namev0.6.0 (Posted on 2021-07-25 19:37:45)
First Release Name0.0.2 (Posted on )
Created At2014-04-05 10:34:17
Pushed At2023-01-11 22:21:30
Last Commit At2021-10-04 13:37:52
Stargazers Count1.3k
Watchers Count70
Fork Count591
Commits Count291
Has Issues Enabled
Issues Count158
Issue Open Count34
Pull Requests Count25
Pull Requests Open Count11
Pull Requests Close Count19
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private
To the top