ps

peerflix-server

Streaming torrent client for Node.js with web ui.

Showing:

Popularity

Downloads/wk

66

GitHub Stars

1.2K

Maintenance

Last Commit

13d ago

Contributors

22

Package

Dependencies

14

License

MIT

Type Definitions

Tree-Shakeable

No?

Readme

peerflix-server

NPM Version NPM Downloads Node.js Version Build Status

logo

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.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 PEERFLIX_CONFIG_PATH environmnt variable. Default value is $HOME/.config/peerflix-server/.

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

PORT=1234 peerflix-server

# or on windows
SET PORT=1234
peerflix-server

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Tutorials

No tutorials found
Add a tutorial