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