aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorChocobozzz <florian.bigard@gmail.com>2016-10-07 11:01:28 +0200
committerChocobozzz <florian.bigard@gmail.com>2016-10-07 11:01:28 +0200
commit82e624233f22eba0230383c7de8a9ed3b69791a6 (patch)
tree9b9df6547149145ca6d7216e252e825cfb5a4951 /README.md
parentaff36eb063573532498979c83be1c279c84f2d53 (diff)
downloadPeerTube-82e624233f22eba0230383c7de8a9ed3b69791a6.tar.gz
PeerTube-82e624233f22eba0230383c7de8a9ed3b69791a6.tar.zst
PeerTube-82e624233f22eba0230383c7de8a9ed3b69791a6.zip
Update documentations now we use webseed instead of electron/webrtc
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/README.md b/README.md
index 777df6d7d..f9d60855a 100644
--- a/README.md
+++ b/README.md
@@ -121,14 +121,13 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
121 121
122#### Debian 122#### Debian
123 123
124 * 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) 124 * Install NodeJS 4.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)
125 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ 125 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
126 * Run: 126 * Run:
127 127
128 # apt-get update 128 # apt-get update
129 # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin 129 # apt-get install ffmpeg mongodb
130 # npm install -g npm@3 130 # npm install -g npm@3
131 # npm install -g electron
132 131
133#### Other distribution... (PR welcome) 132#### Other distribution... (PR welcome)
134 133
@@ -201,9 +200,8 @@ See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITE
201 * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network 200 * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
202 * Each server has a RSA key to encrypt and sign communications with other servers 201 * Each server has a RSA key to encrypt and sign communications with other servers
203 * A server is a tracker responsible for all the videos uploaded in it 202 * A server is a tracker responsible for all the videos uploaded in it
204 * Even if nobody watches a video, it is seeded by the server where the video was uploaded 203 * Even if nobody watches a video, it is seeded by the server (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
205 * A network can live and evolve by expelling bad pod (with too many downtimes for example) 204 * A network can live and evolve by expelling bad pod (with too many downtimes for example)
206 * A server **would** run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
207 205
208See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :) 206See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
209 207
@@ -211,19 +209,19 @@ Here are some simple schemes:
211 209
212<p align="center"> 210<p align="center">
213 211
214<img src="https://lutim.cpy.re/Q7mnNdJP" alt="Decentralized" /> 212<img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
215 213
216<img src="https://lutim.cpy.re/0riSzAp1" alt="Watch a video" /> 214<img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
217 215
218<img src="https://lutim.cpy.re/OzMSOtxG" alt="Watch a P2P video" /> 216<img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
219 217
220<img src="https://lutim.cpy.re/uVjNNRa9" alt="Join a network" /> 218<img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
221 219
222<img src="https://lutim.cpy.re/udTMqcb0" alt="Many networks" 220<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks"
223 221
224</p> 222</p>
225 223
226### Frontend 224### Frontend
227 225
228There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...). 226There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
229The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video with its torrent URI. 227The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.