6 Prototype of a decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
10 <strong>Client</strong>
14 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
15 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
18 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies">
19 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
24 <strong>Server</strong>
28 <a href="https://travis-ci.org/Chocobozzz/PeerTube">
29 <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master" alt="Build Status" />
32 <a href="https://david-dm.org/Chocobozzz/PeerTube">
33 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
36 <a href="https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies">
37 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
40 <a href="https://codeclimate.com/github/Chocobozzz/PeerTube">
41 <img src="https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg" alt="Code climate" />
44 <a href="http://standardjs.com/">
45 <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
48 <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
49 <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
56 <a href="http://peertube.cpy.re">
57 <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
63 Want to see in action?
65 * 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)
66 * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
67 * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly.
71 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.
73 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
74 But it's not enought because one video could become famous and overload the server.
75 It's the reason why we need to use a P2P protocol to limit the server load.
76 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
81 - [X] ~~Simple frontend (All elements are generated by jQuery)~~
82 - [X] Angular 2 frontend
84 - [X] Generate a RSA key
85 - [X] Ask for the friend list of other pods and make friend with them
86 - [X] Get the list of the videos owned by a pod when making friend with it
87 - [X] Post the list of its own videos when making friend with another pod
91 - [X] Send the meta data to all other friends
92 - [X] Remove the video
94 - [X] Search a video name (local index)
95 - [X] View the video in an HTML5 page with WebTorrent
96 - [X] Manage admin account
98 - [X] Account rights (upload...)
99 - [X] Make the network auto sufficient (eject bad pods etc)
100 - [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
101 - [ ] Manage API breaks
102 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
106 - [X] Manage users (create/remove)
109 - [ ] User subscriptions (by tags, author...)
110 - [ ] Signaling a video to the admin pod
114 ### Front compatibility
117 * Firefox (>= 42 for MediaSource support)
129 * Install NodeJS 4.x (actual LTS): [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)
130 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
134 # apt-get install ffmpeg postgresql-9.4 openssl
135 # npm install -g npm@3
137 #### Other distribution... (PR welcome)
142 $ git clone https://github.com/Chocobozzz/PeerTube
144 $ npm install # Or npm install --unsafe-perm for root user
151 If you want to run PeerTube for production (bad idea for now :) ):
153 $ cp config/production.yaml.example config/production.yaml
155 Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
157 Finally, run the server with the `production` `NODE_ENV` variable set.
159 $ NODE_ENV=production npm start
161 **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
163 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
165 You can check the application (CORS headers, tracker websocket...) by running:
167 $ NODE_ENV=production npm run check
171 The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
173 # systemctl stop peertube
175 # systemctl start peertube
179 In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them:
183 ### Test with 3 fresh nodes
185 $ npm run clean:server:test
188 Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. 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 :)
192 To print all available command run:
198 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.
202 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
204 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
206 See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
211 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
215 * The backend is a REST API
216 * Servers communicate with each others through it
217 * A network is composed by servers that communicate between them
218 * Each server of a network has a list of all other servers of this network
219 * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list
220 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
221 * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
222 * Each server has a RSA key to encrypt and sign communications with other servers
223 * A server is a tracker responsible for all the videos uploaded in it
224 * Even if nobody watches a video, it is seeded by the server (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
225 * A network can live and evolve by expelling bad pod (with too many downtimes for example)
227 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
229 Here are some simple schemes:
233 <img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
235 <img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
237 <img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
239 <img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
241 <img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
247 There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
248 The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.