Skip to content

asapach/peerflix-server

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

* Process title added

* Docker enhancements

Added PEERFLIX_CONFIG_PATH env variable
Minimized docker image
Can be run from any user with -u flag, default node(1000):node(1000)

Co-authored-by: Aliaksei Sapach <1755336+asapach@users.noreply.github.com>
adbc91e

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
October 4, 2021 13:37
April 6, 2014 16:57
August 5, 2018 02:15
August 5, 2018 02:13
October 4, 2021 13:37
April 5, 2014 03:34
October 4, 2021 13:37
August 26, 2018 23:55
June 11, 2014 01:24
July 25, 2021 19:37

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