]>
Commit | Line | Data |
---|---|---|
d3b52378 C |
1 | <h1 align="center"> |
2 | PeerTube | |
3 | </h1> | |
8c308c2b | 4 | |
d3b52378 | 5 | <h4 align="center"> |
6f045b57 | 6 | Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>. |
d3b52378 | 7 | </h4> |
88c8d458 | 8 | |
8114c5d8 | 9 | **PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit that promotes, spreads and develops free-libre software. If you want to support this project, please [consider donating them](https://soutenir.framasoft.org/en/).** |
570a60fa | 10 | |
d3b52378 C |
11 | <p align="center"> |
12 | <strong>Client</strong> | |
191ce958 | 13 | |
d3b52378 | 14 | <br /> |
8c308c2b | 15 | |
d3b52378 C |
16 | <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client"> |
17 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" /> | |
18 | </a> | |
19 | ||
28974889 | 20 | <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev"> |
d3b52378 C |
21 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" /> |
22 | </a> | |
23 | </p> | |
24 | ||
25 | <p align="center"> | |
26 | <strong>Server</strong> | |
27 | ||
28 | <br /> | |
29 | ||
30 | <a href="https://travis-ci.org/Chocobozzz/PeerTube"> | |
13fc89f4 | 31 | <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" /> |
d3b52378 C |
32 | </a> |
33 | ||
34 | <a href="https://david-dm.org/Chocobozzz/PeerTube"> | |
35 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" /> | |
36 | </a> | |
37 | ||
28974889 | 38 | <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev"> |
d3b52378 C |
39 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" /> |
40 | </a> | |
41 | ||
d31910dd C |
42 | <a href="http://standardjs.com/"> |
43 | <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" /> | |
d3b52378 | 44 | </a> |
80deae8d | 45 | |
5cefff7d | 46 | <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube"> |
fcc5f77b | 47 | <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" /> |
5cefff7d | 48 | </a> |
d3b52378 | 49 | </p> |
b4c5a1f8 | 50 | |
d31910dd C |
51 | <br /> |
52 | ||
53 | <p align="center"> | |
45ef55fc | 54 | <a href="https://peertube.cpy.re"> |
908f6e5e | 55 | <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" /> |
d31910dd C |
56 | </a> |
57 | </p> | |
15e3cdaa C |
58 | |
59 | ## Demonstration | |
60 | ||
1d1b7891 C |
61 | Want to see in action? |
62 | ||
d5f345ed | 63 | * [Demo server](http://peertube.cpy.re) |
8a02bd04 | 64 | * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see how the "decentralization feature" looks like |
a67b3e76 | 65 | * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly. |
15e3cdaa | 66 | |
88c8d458 C |
67 | ## Why |
68 | ||
343ad675 | 69 | We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth and video storage of its server. |
88c8d458 C |
70 | |
71 | So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example). | |
343ad675 | 72 | But it's not enough because one video could become famous and overload the server. |
88c8d458 | 73 | It's the reason why we need to use a P2P protocol to limit the server load. |
2eb5a041 | 74 | Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now. |
88c8d458 | 75 | |
8c308c2b C |
76 | ## Features |
77 | ||
da817527 | 78 | - [X] Frontend |
361b7df2 | 79 | - [X] Angular frontend |
fcaf1e0a C |
80 | - [X] Join the fediverse |
81 | - [X] Follow other instances | |
82 | - [X] Unfollow an instance | |
83 | - [X] Get for the followers/following list | |
8c308c2b C |
84 | - [X] Upload a video |
85 | - [X] Seed the video | |
fcaf1e0a | 86 | - [X] Send the meta data with ActivityPub to followers |
8c308c2b C |
87 | - [X] Remove the video |
88 | - [X] List the videos | |
fcaf1e0a | 89 | - [X] View the video in an HTML5 player with WebTorrent |
19a08a34 | 90 | - [X] Admin panel |
900f0d2b | 91 | - [X] OpenGraph tags |
604e02ab | 92 | - [X] OEmbed |
00871a26 | 93 | - [X] Update video |
604e02ab | 94 | - [X] Videos view counter |
2d7653dc | 95 | - [X] Videos likes/dislikes |
604e02ab C |
96 | - [X] Transcoding to different definitions |
97 | - [X] Download file/torrent | |
98 | - [X] User video bytes quota | |
fcaf1e0a | 99 | - [X] User video channels |
604e02ab C |
100 | - [X] NSFW warnings/settings |
101 | - [X] Video description in markdown | |
102 | - [X] User roles (administrator, moderator) | |
00871a26 | 103 | - [X] User registration |
604e02ab | 104 | - [X] Video privacy settings (public, unlisted or private) |
fcaf1e0a | 105 | - [X] Signaling a video to the admin origin PeerTube instance |
604e02ab C |
106 | - [ ] Videos comments |
107 | - [ ] User playlist | |
108 | - [ ] User subscriptions (by tags, author...) | |
fcaf1e0a | 109 | - [ ] Add "DDOS" security |
00871a26 | 110 | |
8c308c2b | 111 | |
94171ec5 | 112 | ## Installation |
8c308c2b | 113 | |
199cef3a C |
114 | See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands. |
115 | ||
88c8d458 | 116 | ### Front compatibility |
8c308c2b | 117 | |
88c8d458 C |
118 | * Chromium |
119 | * Firefox (>= 42 for MediaSource support) | |
8c308c2b C |
120 | |
121 | ### Dependencies | |
122 | ||
9a989f81 | 123 | * **NodeJS >= 8.x** |
85cd99dc | 124 | * yarn |
8c308c2b | 125 | * OpenSSL (cli) |
8c67719c | 126 | * PostgreSQL |
80deae8d | 127 | * FFmpeg |
8c308c2b | 128 | |
c35ae59d C |
129 | #### Debian |
130 | ||
6f045b57 | 131 | 1. Install NodeJS 8.x (current 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) |
0273fe81 | 132 | 2. Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) |
0273fe81 | 133 | 4. Run: |
c35ae59d | 134 | |
9a989f81 | 135 | $ apt-get update |
6f045b57 | 136 | $ apt-get install ffmpeg postgresql openssl |
0273fe81 JK |
137 | |
138 | #### Ubuntu 16.04 | |
139 | ||
140 | 1. Install NodeJS 8.x (current LTS): (same as Debian) | |
141 | 2. Install yarn: (same as Debian) | |
142 | 3. Run: | |
143 | ||
9a989f81 C |
144 | $ apt-get update |
145 | $ apt-get install ffmpeg postgresql openssl | |
c35ae59d | 146 | |
94171ec5 C |
147 | #### Other distribution... (PR welcome) |
148 | ||
c35ae59d | 149 | |
94171ec5 | 150 | ### Sources |
8c308c2b | 151 | |
80deae8d | 152 | $ git clone -b master https://github.com/Chocobozzz/PeerTube |
d148f3b9 | 153 | $ cd PeerTube |
85cd99dc | 154 | $ yarn install |
26939223 | 155 | $ npm run build |
94171ec5 C |
156 | |
157 | ## Usage | |
158 | ||
f1f4732f C |
159 | ### Production |
160 | ||
161 | If you want to run PeerTube for production (bad idea for now :) ): | |
162 | ||
163 | $ cp config/production.yaml.example config/production.yaml | |
164 | ||
10862660 | 165 | Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`. |
f1f4732f C |
166 | |
167 | Finally, run the server with the `production` `NODE_ENV` variable set. | |
168 | ||
169 | $ NODE_ENV=production npm start | |
170 | ||
9a5d2a3f C |
171 | The administrator password is automatically generated and can be found in the logs. You can set another password with: |
172 | ||
173 | $ NODE_ENV=production npm run reset-password -- -u root | |
174 | ||
199cef3a | 175 | **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br /> |
10d0963e C |
176 | **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd |
177 | ||
844e39c2 C |
178 | You can check the application (CORS headers, tracker websocket...) by running: |
179 | ||
180 | $ NODE_ENV=production npm run check | |
181 | ||
643a5fc5 C |
182 | ### Upgrade |
183 | ||
184 | The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: | |
185 | ||
186 | # systemctl stop peertube | |
4f133041 | 187 | $ npm run upgrade-peertube |
643a5fc5 C |
188 | # systemctl start peertube |
189 | ||
fd8e5e3c C |
190 | ### Development |
191 | ||
fcaf1e0a | 192 | In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds. |
10862660 | 193 | |
343ad675 | 194 | To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too): |
66dd264f C |
195 | |
196 | $ npm run dev:server | |
197 | ||
ed5f9163 C |
198 | The server (with the client) will listen on `localhost:9000`. |
199 | ||
200 | ||
66dd264f C |
201 | To develop on the client side (client files are automatically compiled when we modify them): |
202 | ||
203 | $ npm run dev:client | |
fd8e5e3c | 204 | |
ed5f9163 C |
205 | The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser). |
206 | ||
41aa84cc C |
207 | **Username**: *root* <br/> |
208 | **Password**: *test* | |
9a5d2a3f | 209 | |
fd8e5e3c C |
210 | ### Test with 3 fresh nodes |
211 | ||
212 | $ npm run clean:server:test | |
213 | $ npm run play | |
214 | ||
fcaf1e0a | 215 | Then you will get access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. |
fd8e5e3c | 216 | |
94171ec5 C |
217 | ### Other commands |
218 | ||
219 | To print all available command run: | |
220 | ||
221 | $ npm run help | |
222 | ||
6dde6a31 C |
223 | ## Contributing |
224 | ||
225 | See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md). | |
226 | ||
227 | See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). | |
228 | ||
fd8e5e3c C |
229 | See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md). |
230 | ||
6dde6a31 | 231 | |
8c308c2b C |
232 | ## Architecture |
233 | ||
241abd69 BF |
234 | See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication. |
235 | ||
8c308c2b C |
236 | ### Backend |
237 | ||
1ca81df4 | 238 | * The backend is a REST API |
fcaf1e0a C |
239 | * Servers communicate with each others with [Activity Pub](https://www.w3.org/TR/activitypub/) |
240 | * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...) | |
241 | * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers | |
8c308c2b | 242 | * A server is a tracker responsible for all the videos uploaded in it |
604e02ab | 243 | * Even if nobody watches a video, it is seeded by the server (through [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded |
8c308c2b C |
244 | |
245 | Here are some simple schemes: | |
246 | ||
d3b52378 C |
247 | <p align="center"> |
248 | ||
a988e81c | 249 | <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" /> |
d3b52378 | 250 | |
a988e81c | 251 | <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" /> |
8c308c2b | 252 | |
a988e81c | 253 | <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" /> |
8c308c2b | 254 | |
d3b52378 | 255 | </p> |