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