peerflix-server

Streaming torrent client for Node.js with web ui.

Stars
1.29K
Forks
621
Open issues
46
Closed issues
124
Last release
almost 3 years ago
Last commit
over 2 years ago
Watchers
1.29K
Total releases
10
Total commits
291
Open PRs
12
Closed PRs
25
Repo URL
Platform
License
mit
Category
Usecase
Offers premium version?
NO
Proprietary?
NO
About

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.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

Alternative Projects
No projects found

Subscribe to Open Source Businees Newsletter

Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.

We'll never share your email with anyone else.