3 [![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
4 [![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
5 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
6 [![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
8 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
10 [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
14 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.
16 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
17 But it's not enought because one video could become famous and overload the server.
18 It's the reason why we need to use a P2P protocol to limit the server load.
19 Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
24 - [X] Simple frontend (All elements are generated by jQuery)
25 - [ ] Angular 2 frontend
27 - [X] Generate a RSA key
28 - [X] Ask for the friend list of other pods and make friend with them
29 - [X] Get the list of the videos owned by a pod when making friend with it
30 - [X] Post the list of its own videos when making friend with another pod
34 - [X] Send the meta data to all other friends
35 - [X] Remove the video
37 - [X] Search a video name (local index)
38 - [X] View the video in an HTML5 page with webtorrent
39 - [ ] Manage user accounts
42 - [ ] Account rights (upload...)
43 - [X] Make the network auto sufficient (eject bad pods etc)
44 - [ ] Manage API breaks
45 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
50 ### Front compatibility
53 * Firefox (>= 42 for MediaSource support)
60 * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
64 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)
66 # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
67 # npm install -g electron-prebuilt
72 $ git clone https://github.com/Chocobozzz/PeerTube
74 # npm install -g electron-prebuilt
79 ### Test with 3 fresh nodes
84 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 :)
88 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.
92 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
96 * The backend whould be a REST API
97 * Servers would communicate with each others with it
98 * Each server of a network has a list of all other servers of the network
99 * 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"
100 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
101 * 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
102 * Each server has a RSA key to encrypt and sign communications with other servers
103 * A server is a tracker responsible for all the videos uploaded in it
104 * Even if nobody watches a video, it is seeded by the server where the video was uploaded
105 * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
106 * A network can live and evolve by expelling bad pod (with too many downtimes for example)
108 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
110 Here are some simple schemes:
112 ![Decentralized](http://lutim.cpy.re/aV2pawRz)
114 ![Watch a video](http://lutim.cpy.re/AlOeoVPi)
116 ![Watch a video P2P](http://lutim.cpy.re/fb0JH6C3)
118 ![Join a network](http://lutim.cpy.re/ijuCgmpI)
120 ![Many networks](http://lutim.cpy.re/iz8mXHug)
124 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...).
125 The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.