6 Decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
9 **PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit that promotes, spreads and develops free-libre software. If you want to support this project, please [consider donating them](https://soutenir.framasoft.org/en/).**
12 <strong>Client</strong>
16 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
17 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
20 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
21 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
26 <strong>Server</strong>
30 <a href="https://travis-ci.org/Chocobozzz/PeerTube">
31 <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
34 <a href="https://david-dm.org/Chocobozzz/PeerTube">
35 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
38 <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
39 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
42 <a href="http://standardjs.com/">
43 <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
46 <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
47 <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
54 <a href="https://peertube.cpy.re">
55 <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
61 Want to see in action?
63 * [Demo server](http://peertube.cpy.re)
64 * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see how the "decentralization feature" looks like
65 * 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.
69 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.
71 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
72 But it's not enought because one video could become famous and overload the server.
73 It's the reason why we need to use a P2P protocol to limit the server load.
74 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
79 - [X] Angular frontend
81 - [X] Generate a RSA key
82 - [X] Ask for the friend list of other pods and make friend with them
83 - [X] Get the list of the videos owned by a pod when making friend with it
84 - [X] Post the list of its own videos when making friend with another pod
88 - [X] Send the meta data to all other friends
89 - [X] Remove the video
91 - [X] Search a video name (local index)
92 - [X] View the video in an HTML5 page with WebTorrent
93 - [X] Manage admin account
95 - [X] Account rights (upload...)
96 - [X] Make the network auto sufficient (eject bad pods etc)
97 - [X] Validate the prototype (test PeerTube in a real world)
98 - [ ] Manage inter pod API breaks
99 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
103 - [X] Manage users (create/remove)
107 - [X] Videos view counter
108 - [X] Videos likes/dislikes
109 - [X] Transcoding to different definitions
110 - [X] Download file/torrent
111 - [X] User video bytes quota
113 - [X] NSFW warnings/settings
114 - [X] Video description in markdown
115 - [X] User roles (administrator, moderator)
116 - [X] User registration
117 - [X] Video privacy settings (public, unlisted or private)
118 - [X] Signaling a video to the admin origin pod
119 - [ ] Videos comments
121 - [ ] User subscriptions (by tags, author...)
126 See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
128 ### Front compatibility
131 * Firefox (>= 42 for MediaSource support)
144 * Install NodeJS 6.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)
145 * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
146 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
150 # apt-get install ffmpeg postgresql-9.4 openssl
152 #### Other distribution... (PR welcome)
157 $ git clone -b master https://github.com/Chocobozzz/PeerTube
166 If you want to run PeerTube for production (bad idea for now :) ):
168 $ cp config/production.yaml.example config/production.yaml
170 Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
172 Finally, run the server with the `production` `NODE_ENV` variable set.
174 $ NODE_ENV=production npm start
176 The administrator password is automatically generated and can be found in the logs. You can set another password with:
178 $ NODE_ENV=production npm run reset-password -- -u root
180 **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
181 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
183 You can check the application (CORS headers, tracker websocket...) by running:
185 $ NODE_ENV=production npm run check
189 The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
191 # systemctl stop peertube
192 $ npm run upgrade-peertube
193 # systemctl start peertube
197 In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds.
199 To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too):
203 The server (with the client) will listen on `localhost:9000`.
206 To develop on the client side (client files are automatically compiled when we modify them):
210 The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser).
212 **Username**: *root* <br/>
215 ### Test with 3 fresh nodes
217 $ npm run clean:server:test
220 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 :)
224 To print all available command run:
230 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.
234 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
236 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
238 See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
243 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
247 * The backend is a REST API
248 * Servers communicate with each others through it
249 * A network is composed by servers that communicate between them
250 * Each server of a network has a list of all other servers of this network
251 * 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
252 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
253 * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) to each server of the network
254 * Each server has a RSA key to encrypt and sign communications with other servers
255 * A server is a tracker responsible for all the videos uploaded in it
256 * Even if nobody watches a video, it is seeded by the server (through [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
257 * A network can live and evolve by expelling bad pod (with too many downtime for example)
259 See the ARCHITECTURE.md for more information. Do not hesitate to give your opinion :)
261 Here are some simple schemes:
265 <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
267 <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
269 <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
271 <img src="https://lutim.cpy.re/wWVuczBz.png" alt="Join a network" />
273 <img src="https://lutim.cpy.re/AMo3uP0D.png" alt="Many networks" />
279 There already is a frontend (Angular) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
280 The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.