]>
Commit | Line | Data |
---|---|---|
d148f3b9 | 1 | # PeerTube |
8c308c2b | 2 | |
88c8d458 | 3 | [![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube) |
dcc700d2 | 4 | [![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube) |
3dca0e6e | 5 | [![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube) |
88c8d458 C |
6 | |
7 | Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent). | |
8c308c2b C |
8 | |
9 | [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) | |
10 | ||
88c8d458 C |
11 | ## Why |
12 | ||
13 | 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. | |
14 | ||
15 | So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example). | |
16 | But it's not enought because one video could become famous and overload the server. | |
17 | It's the reason why we need to use a P2P protocol to limit the server load. | |
18 | Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now. | |
19 | ||
8c308c2b C |
20 | ## Features |
21 | ||
88c8d458 C |
22 | - [ ] Frontend |
23 | - [X] Simple frontend (All elements are generated by jQuery) | |
24 | - [ ] AngularJS frontend | |
45239549 | 25 | - [X] Join a network |
8c308c2b C |
26 | - [X] Generate a RSA key |
27 | - [X] Ask for the friend list of other pods and make friend with them | |
45239549 C |
28 | - [X] Get the list of the videos owned by a pod when making friend with it |
29 | - [X] Post the list of its own videos when making friend with another pod | |
30 | - [X] Quit a network | |
8c308c2b C |
31 | - [X] Upload a video |
32 | - [X] Seed the video | |
33 | - [X] Send the meta data to all other friends | |
34 | - [X] Remove the video | |
35 | - [X] List the videos | |
36 | - [X] Search a video name (local index) | |
37 | - [X] View the video in an HTML5 page with webtorrent | |
38 | - [ ] Manage user accounts | |
39 | - [ ] Inscription | |
40 | - [ ] Connection | |
41 | - [ ] Account rights (upload...) | |
3bcb78b3 | 42 | - [X] Make the network auto sufficient (eject bad pods etc) |
8c308c2b C |
43 | - [ ] Manage API breaks |
44 | - [ ] Add "DDOS" security (check if a pod don't send too many requests for example) | |
45 | ||
8c308c2b | 46 | |
88c8d458 | 47 | ## Usage |
8c308c2b | 48 | |
88c8d458 | 49 | ### Front compatibility |
8c308c2b | 50 | |
88c8d458 C |
51 | * Chromium |
52 | * Firefox (>= 42 for MediaSource support) | |
8c308c2b C |
53 | |
54 | ### Dependencies | |
55 | ||
86435b9b | 56 | * **NodeJS >= 4.2** |
8c308c2b C |
57 | * OpenSSL (cli) |
58 | * MongoDB | |
3a443402 | 59 | * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron) |
8c308c2b | 60 | |
c35ae59d C |
61 | #### Debian |
62 | ||
63 | 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) | |
64 | ||
65 | # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 | |
c35ae59d C |
66 | # npm install -g electron-prebuilt |
67 | ||
68 | ||
8c308c2b C |
69 | ### Test It! |
70 | ||
71 | $ git clone https://github.com/Chocobozzz/PeerTube | |
d148f3b9 | 72 | $ cd PeerTube |
8c308c2b C |
73 | # npm install -g electron-prebuilt |
74 | $ npm install | |
75 | $ npm start | |
76 | ||
9e0e8506 | 77 | ### Test with 3 fresh nodes |
88c8d458 | 78 | |
e7870ff3 C |
79 | $ bin/clean_test.sh |
80 | $ bin/run_servers.sh | |
8c308c2b | 81 | |
c35ae59d | 82 | 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 :) |
8c308c2b | 83 | |
a6fa7ac1 | 84 | ### Dockerfile |
8c308c2b | 85 | |
a6fa7ac1 | 86 | 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. |
8c308c2b C |
87 | |
88 | ## Architecture | |
89 | ||
241abd69 BF |
90 | See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication. |
91 | ||
8c308c2b C |
92 | ### Backend |
93 | ||
94 | * The backend whould be a REST API | |
95 | * Servers would communicate with each others with it | |
96 | * Each server of a network has a list of all other servers of the network | |
97 | * 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" | |
98 | * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...) | |
99 | * 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 | |
100 | * Each server has a RSA key to encrypt and sign communications with other servers | |
101 | * A server is a tracker responsible for all the videos uploaded in it | |
102 | * Even if nobody watches a video, it is seeded by the server where the video was uploaded | |
103 | * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol | |
104 | * A network can live and evolve by expelling bad pod (with too many downtimes for example) | |
105 | ||
106 | See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :) | |
107 | ||
108 | Here are some simple schemes: | |
109 | ||
110 | ![Decentralized](http://lutim.cpy.re/aV2pawRz) | |
111 | ||
112 | ![Watch a video](http://lutim.cpy.re/AlOeoVPi) | |
113 | ||
114 | ![Watch a video P2P](http://lutim.cpy.re/fb0JH6C3) | |
115 | ||
116 | ![Join a network](http://lutim.cpy.re/ijuCgmpI) | |
117 | ||
118 | ![Many networks](http://lutim.cpy.re/iz8mXHug) | |
119 | ||
120 | ### Frontend | |
121 | ||
122 | 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...). | |
88c8d458 | 123 | The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI. |