4 [![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
5 [![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
6 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
7 [![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
10 [![Dependency Status](https://david-dm.org/Chocobozzz/PeerTube.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client)
11 [![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
13 [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
15 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
17 ![screenshot](https://lutim.cpy.re/vC2loRww)
21 Want to see in action?
23 * 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)
24 * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
28 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.
30 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
31 But it's not enought because one video could become famous and overload the server.
32 It's the reason why we need to use a P2P protocol to limit the server load.
33 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
38 - [X] ~~Simple frontend (All elements are generated by jQuery)~~
39 - [X] Angular 2 frontend
41 - [X] Generate a RSA key
42 - [X] Ask for the friend list of other pods and make friend with them
43 - [X] Get the list of the videos owned by a pod when making friend with it
44 - [X] Post the list of its own videos when making friend with another pod
48 - [X] Send the meta data to all other friends
49 - [X] Remove the video
51 - [X] Search a video name (local index)
52 - [X] View the video in an HTML5 page with WebTorrent
53 - [ ] Manage user accounts
56 - [X] Account rights (upload...)
57 - [X] Make the network auto sufficient (eject bad pods etc)
58 - [ ] Manage API breaks
59 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
64 ### Front compatibility
67 * Firefox (>= 42 for MediaSource support)
74 * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
78 * 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)
79 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
83 # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
84 # npm install -g electron-prebuilt
86 #### Other distribution... (PR welcome)
91 $ git clone https://github.com/Chocobozzz/PeerTube
102 ### Test with 3 fresh nodes
104 $ npm run clean:server:test
107 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 :)
111 If you want to run PeerTube for production (bad idea for now :) ):
113 $ cp config/production.yaml.example config/production.yaml
115 Then edit the `config/production.yaml` file according to your webserver configuration.
117 Finally, run the server with the `production` `NODE_ENV` variable set.
119 $ NODE_ENV=production npm start
123 To print all available command run:
129 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.
133 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
137 * The backend whould be a REST API
138 * Servers would communicate with each others with it
139 * Each server of a network has a list of all other servers of the network
140 * 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"
141 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
142 * 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
143 * Each server has a RSA key to encrypt and sign communications with other servers
144 * A server is a tracker responsible for all the videos uploaded in it
145 * Even if nobody watches a video, it is seeded by the server where the video was uploaded
146 * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
147 * A network can live and evolve by expelling bad pod (with too many downtimes for example)
149 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
151 Here are some simple schemes:
153 ![Decentralized](https://lutim.cpy.re/Q7mnNdJP)
155 ![Watch a video](https://lutim.cpy.re/0riSzAp1)
157 ![Watch a video P2P](https://lutim.cpy.re/OzMSOtxG)
159 ![Join a network](https://lutim.cpy.re/uVjNNRa9)
161 ![Many networks](https://lutim.cpy.re/udTMqcb0)
165 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...).
166 The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.