PeerTube/README.md

171 lines
7.3 KiB
Markdown
Raw Normal View History

# PeerTube
2015-06-09 17:41:40 +02:00
2016-05-11 20:01:01 +02:00
**Server**
[![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
2015-12-05 10:17:14 +01:00
[![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
2016-04-27 22:27:27 +02:00
[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
2016-02-14 10:07:17 +01:00
[![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
2016-05-11 20:01:01 +02:00
**Client**
2016-04-30 08:56:21 +02:00
[![Dependency Status](https://david-dm.org/Chocobozzz/PeerTube.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client)
[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
2015-06-09 17:41:40 +02:00
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
2016-05-11 20:01:01 +02:00
Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
![screenshot](https://lutim.cpy.re/vC2loRww)
## Demonstration
2016-06-05 10:49:01 +02:00
Want to see in action?
* You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC)
* You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
## Why
We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enought money to pay bandwith and video storage of its server.
So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
But it's not enought because one video could become famous and overload the server.
It's the reason why we need to use a P2P protocol to limit the server load.
2016-04-30 13:13:07 +02:00
Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
2015-06-09 17:41:40 +02:00
## Features
2016-04-28 19:31:08 +02:00
- [X] Frontend
2016-04-27 22:28:31 +02:00
- [X] ~~Simple frontend (All elements are generated by jQuery)~~
- [X] Angular 2 frontend
- [X] Join a network
2015-06-09 17:41:40 +02:00
- [X] Generate a RSA key
- [X] Ask for the friend list of other pods and make friend with them
- [X] Get the list of the videos owned by a pod when making friend with it
- [X] Post the list of its own videos when making friend with another pod
- [X] Quit a network
2015-06-09 17:41:40 +02:00
- [X] Upload a video
- [X] Seed the video
- [X] Send the meta data to all other friends
- [X] Remove the video
- [X] List the videos
- [X] Search a video name (local index)
2016-04-30 13:13:07 +02:00
- [X] View the video in an HTML5 page with WebTorrent
2016-06-18 16:16:30 +02:00
- [X] Manage admin account
2016-04-28 19:31:08 +02:00
- [X] Connection
- [X] Account rights (upload...)
- [X] Make the network auto sufficient (eject bad pods etc)
2016-06-15 21:11:05 +02:00
- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
2015-06-09 17:41:40 +02:00
- [ ] Manage API breaks
- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
2016-06-15 21:11:05 +02:00
- [ ] Admin panel
- [ ] Stats about the network (how many friends, how many requests per hour...)
- [ ] Stats about videos
- [ ] Manage users (create/remove)
2015-06-09 17:41:40 +02:00
2016-04-30 12:56:44 +02:00
## Installation
2015-06-09 17:41:40 +02:00
### Front compatibility
2015-06-09 17:41:40 +02:00
* Chromium
* Firefox (>= 42 for MediaSource support)
2015-06-09 17:41:40 +02:00
### Dependencies
* **NodeJS >= 4.2**
2015-06-09 17:41:40 +02:00
* OpenSSL (cli)
* MongoDB
2016-05-03 22:41:46 +02:00
* ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
2015-06-09 17:41:40 +02:00
2016-02-14 10:29:35 +01:00
#### Debian
2016-05-03 22:41:46 +02:00
* Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
* Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
2016-05-03 22:56:52 +02:00
* Run:
2016-02-14 10:29:35 +01:00
2016-05-03 22:56:52 +02:00
# apt-get update
# apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
# npm install -g electron-prebuilt
2016-02-14 10:29:35 +01:00
2016-04-30 12:56:44 +02:00
#### Other distribution... (PR welcome)
2016-02-14 10:29:35 +01:00
2016-04-30 12:56:44 +02:00
### Sources
2015-06-09 17:41:40 +02:00
$ git clone https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
2015-06-09 17:41:40 +02:00
$ npm install
2016-04-26 23:02:46 +02:00
$ npm run build
2016-04-30 12:56:44 +02:00
## Usage
2016-05-20 15:27:16 +02:00
### Development
2016-04-30 12:56:44 +02:00
2015-06-09 17:41:40 +02:00
$ npm start
2015-10-29 23:17:06 +01:00
### Test with 3 fresh nodes
2016-04-30 12:56:44 +02:00
$ npm run clean:server:test
$ npm run play
2015-06-09 17:41:40 +02:00
2016-02-14 10:29:35 +01:00
Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
2015-06-09 17:41:40 +02:00
2016-05-20 15:27:16 +02:00
### Production
If you want to run PeerTube for production (bad idea for now :) ):
$ cp config/production.yaml.example config/production.yaml
Then edit the `config/production.yaml` file according to your webserver configuration.
Finally, run the server with the `production` `NODE_ENV` variable set.
$ NODE_ENV=production npm start
2016-04-30 12:56:44 +02:00
### Other commands
To print all available command run:
$ npm run help
## Dockerfile
2015-06-09 17:41:40 +02:00
2015-11-03 09:05:03 +01:00
You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
2015-06-09 17:41:40 +02:00
## Architecture
2015-10-29 23:18:17 +01:00
See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
2015-06-09 17:41:40 +02:00
### Backend
* The backend whould be a REST API
* Servers would communicate with each others with it
* Each server of a network has a list of all other servers of the network
* When a new installed server wants to join a network, it just has to get the list of the servers via one server and tell them "Hi I'm new in the network, communicate with me too please"
* Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
* Server begins to seed and sends to the other servers of the network the video information (name, short description, torrent URI) of a new uploaded video
* Each server has a RSA key to encrypt and sign communications with other servers
* A server is a tracker responsible for all the videos uploaded in it
* Even if nobody watches a video, it is seeded by the server where the video was uploaded
* A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
* A network can live and evolve by expelling bad pod (with too many downtimes for example)
See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
Here are some simple schemes:
![Decentralized](https://lutim.cpy.re/Q7mnNdJP)
2015-06-09 17:41:40 +02:00
![Watch a video](https://lutim.cpy.re/0riSzAp1)
2015-06-09 17:41:40 +02:00
![Watch a video P2P](https://lutim.cpy.re/OzMSOtxG)
2015-06-09 17:41:40 +02:00
![Join a network](https://lutim.cpy.re/uVjNNRa9)
2015-06-09 17:41:40 +02:00
![Many networks](https://lutim.cpy.re/udTMqcb0)
2015-06-09 17:41:40 +02:00
### Frontend
There would be a simple frontend (Bootstrap, AngularJS) but since the backend is a REST API anybody could build a frontend (Web application, desktop application...).
The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.