]>
Commit | Line | Data |
---|---|---|
d3b52378 C |
1 | <h1 align="center"> |
2 | PeerTube | |
3 | </h1> | |
8c308c2b | 4 | |
d3b52378 | 5 | <h4 align="center"> |
fe783f6b | 6 | Decentralized 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 C |
54 | <a href="https://peertube.cpy.re"> |
55 | <img src="https://lutim.cpy.re/9HOUfGK8" 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 | ||
85ec3eb7 | 123 | * **NodeJS >= 6.x** |
2559aa3b | 124 | * **npm >= 3.x** |
85cd99dc | 125 | * yarn |
8c308c2b | 126 | * OpenSSL (cli) |
8c67719c | 127 | * PostgreSQL |
80deae8d | 128 | * FFmpeg |
8c308c2b | 129 | |
c35ae59d C |
130 | #### Debian |
131 | ||
85ec3eb7 | 132 | * Install NodeJS 6.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) |
85cd99dc | 133 | * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) |
3a8a8b51 | 134 | * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ |
2e2b64c5 | 135 | * Run: |
c35ae59d | 136 | |
2e2b64c5 | 137 | # apt-get update |
8c67719c | 138 | # apt-get install ffmpeg postgresql-9.4 openssl |
c35ae59d | 139 | |
94171ec5 C |
140 | #### Other distribution... (PR welcome) |
141 | ||
c35ae59d | 142 | |
94171ec5 | 143 | ### Sources |
8c308c2b | 144 | |
80deae8d | 145 | $ git clone -b master https://github.com/Chocobozzz/PeerTube |
d148f3b9 | 146 | $ cd PeerTube |
85cd99dc | 147 | $ yarn install |
26939223 | 148 | $ npm run build |
94171ec5 C |
149 | |
150 | ## Usage | |
151 | ||
f1f4732f C |
152 | ### Production |
153 | ||
154 | If you want to run PeerTube for production (bad idea for now :) ): | |
155 | ||
156 | $ cp config/production.yaml.example config/production.yaml | |
157 | ||
10862660 | 158 | 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 |
159 | |
160 | Finally, run the server with the `production` `NODE_ENV` variable set. | |
161 | ||
162 | $ NODE_ENV=production npm start | |
163 | ||
9a5d2a3f C |
164 | The administrator password is automatically generated and can be found in the logs. You can set another password with: |
165 | ||
166 | $ NODE_ENV=production npm run reset-password -- -u root | |
167 | ||
199cef3a | 168 | **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br /> |
10d0963e C |
169 | **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd |
170 | ||
844e39c2 C |
171 | You can check the application (CORS headers, tracker websocket...) by running: |
172 | ||
173 | $ NODE_ENV=production npm run check | |
174 | ||
643a5fc5 C |
175 | ### Upgrade |
176 | ||
177 | The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: | |
178 | ||
179 | # systemctl stop peertube | |
4f133041 | 180 | $ npm run upgrade-peertube |
643a5fc5 C |
181 | # systemctl start peertube |
182 | ||
fd8e5e3c C |
183 | ### Development |
184 | ||
fcaf1e0a | 185 | In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds. |
10862660 | 186 | |
343ad675 | 187 | To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too): |
66dd264f C |
188 | |
189 | $ npm run dev:server | |
190 | ||
ed5f9163 C |
191 | The server (with the client) will listen on `localhost:9000`. |
192 | ||
193 | ||
66dd264f C |
194 | To develop on the client side (client files are automatically compiled when we modify them): |
195 | ||
196 | $ npm run dev:client | |
fd8e5e3c | 197 | |
ed5f9163 C |
198 | 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). |
199 | ||
41aa84cc C |
200 | **Username**: *root* <br/> |
201 | **Password**: *test* | |
9a5d2a3f | 202 | |
fd8e5e3c C |
203 | ### Test with 3 fresh nodes |
204 | ||
205 | $ npm run clean:server:test | |
206 | $ npm run play | |
207 | ||
fcaf1e0a | 208 | 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 | 209 | |
94171ec5 C |
210 | ### Other commands |
211 | ||
212 | To print all available command run: | |
213 | ||
214 | $ npm run help | |
215 | ||
6dde6a31 C |
216 | ## Contributing |
217 | ||
218 | See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md). | |
219 | ||
220 | See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). | |
221 | ||
fd8e5e3c C |
222 | See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md). |
223 | ||
6dde6a31 | 224 | |
8c308c2b C |
225 | ## Architecture |
226 | ||
241abd69 BF |
227 | See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication. |
228 | ||
8c308c2b C |
229 | ### Backend |
230 | ||
1ca81df4 | 231 | * The backend is a REST API |
fcaf1e0a C |
232 | * Servers communicate with each others with [Activity Pub](https://www.w3.org/TR/activitypub/) |
233 | * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...) | |
234 | * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers | |
8c308c2b | 235 | * A server is a tracker responsible for all the videos uploaded in it |
604e02ab | 236 | * 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 |
237 | |
238 | Here are some simple schemes: | |
239 | ||
d3b52378 C |
240 | <p align="center"> |
241 | ||
a988e81c | 242 | <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" /> |
d3b52378 | 243 | |
a988e81c | 244 | <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" /> |
8c308c2b | 245 | |
a988e81c | 246 | <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" /> |
8c308c2b | 247 | |
d3b52378 | 248 | </p> |