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