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" />
46 <a href="https://github.com/feross/standard">
47 <img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" alt="js-standard-style" />
51 ![screenshot](https://lutim.cpy.re/vC2loRww)
55 Want to see in action?
57 * 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)
58 * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
62 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.
64 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
65 But it's not enought because one video could become famous and overload the server.
66 It's the reason why we need to use a P2P protocol to limit the server load.
67 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
72 - [X] ~~Simple frontend (All elements are generated by jQuery)~~
73 - [X] Angular 2 frontend
75 - [X] Generate a RSA key
76 - [X] Ask for the friend list of other pods and make friend with them
77 - [X] Get the list of the videos owned by a pod when making friend with it
78 - [X] Post the list of its own videos when making friend with another pod
82 - [X] Send the meta data to all other friends
83 - [X] Remove the video
85 - [X] Search a video name (local index)
86 - [X] View the video in an HTML5 page with WebTorrent
87 - [X] Manage admin account
89 - [X] Account rights (upload...)
90 - [X] Make the network auto sufficient (eject bad pods etc)
91 - [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
92 - [ ] Manage API breaks
93 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
95 - [ ] Stats about the network (how many friends, how many requests per hour...)
96 - [ ] Stats about videos
97 - [ ] Manage users (create/remove)
102 ### Front compatibility
105 * Firefox (>= 42 for MediaSource support)
112 * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
116 * 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)
117 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
121 # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
122 # npm install -g electron-prebuilt
124 #### Other distribution... (PR welcome)
129 $ git clone https://github.com/Chocobozzz/PeerTube
140 ### Test with 3 fresh nodes
142 $ npm run clean:server:test
145 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 :)
149 If you want to run PeerTube for production (bad idea for now :) ):
151 $ cp config/production.yaml.example config/production.yaml
153 Then edit the `config/production.yaml` file according to your webserver configuration.
155 Finally, run the server with the `production` `NODE_ENV` variable set.
157 $ NODE_ENV=production npm start
161 To print all available command run:
167 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.
171 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
175 * The backend whould be a REST API
176 * Servers would communicate with each others with it
177 * Each server of a network has a list of all other servers of the network
178 * 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"
179 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
180 * 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
181 * Each server has a RSA key to encrypt and sign communications with other servers
182 * A server is a tracker responsible for all the videos uploaded in it
183 * Even if nobody watches a video, it is seeded by the server where the video was uploaded
184 * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
185 * A network can live and evolve by expelling bad pod (with too many downtimes for example)
187 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
189 Here are some simple schemes:
193 <img src="https://lutim.cpy.re/Q7mnNdJP" alt="Decentralized" />
195 <img src="https://lutim.cpy.re/0riSzAp1" alt="Watch a video" />
197 <img src="https://lutim.cpy.re/OzMSOtxG" alt="Watch a P2P video" />
199 <img src="https://lutim.cpy.re/uVjNNRa9" alt="Join a network" />
201 <img src="https://lutim.cpy.re/udTMqcb0" alt="Many networks"
207 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...).
208 The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.