]>
Commit | Line | Data |
---|---|---|
d3b52378 C |
1 | <h1 align="center"> |
2 | PeerTube | |
3 | </h1> | |
8c308c2b | 4 | |
d3b52378 | 5 | <h4 align="center"> |
e755a63a BB |
6 | Federated (ActivityPub) video streaming platform using P2P (BitTorrent) |
7 | directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>. | |
d3b52378 | 8 | </h4> |
88c8d458 | 9 | |
e755a63a BB |
10 | **PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit |
11 | that promotes, spreads and develops free culture in general, and free-libre | |
12 | software in particular. If you want to support this project, please [consider | |
6139124c | 13 | donating to them](https://soutenir.framasoft.org/en/).** |
570a60fa | 14 | |
d3b52378 C |
15 | <p align="center"> |
16 | <strong>Client</strong> | |
191ce958 | 17 | |
d3b52378 | 18 | <br /> |
8c308c2b | 19 | |
d3b52378 C |
20 | <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client"> |
21 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" /> | |
22 | </a> | |
23 | ||
c27c3a27 | 24 | <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev"> |
d3b52378 C |
25 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" /> |
26 | </a> | |
27 | </p> | |
28 | ||
29 | <p align="center"> | |
30 | <strong>Server</strong> | |
31 | ||
32 | <br /> | |
33 | ||
34 | <a href="https://travis-ci.org/Chocobozzz/PeerTube"> | |
13fc89f4 | 35 | <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" /> |
d3b52378 C |
36 | </a> |
37 | ||
38 | <a href="https://david-dm.org/Chocobozzz/PeerTube"> | |
39 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" /> | |
40 | </a> | |
41 | ||
c27c3a27 | 42 | <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev"> |
d3b52378 C |
43 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" /> |
44 | </a> | |
45 | ||
d31910dd C |
46 | <a href="http://standardjs.com/"> |
47 | <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" /> | |
d3b52378 | 48 | </a> |
80deae8d | 49 | |
5cefff7d | 50 | <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube"> |
fcc5f77b | 51 | <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" /> |
5cefff7d | 52 | </a> |
d3b52378 | 53 | </p> |
b4c5a1f8 | 54 | |
d31910dd C |
55 | <br /> |
56 | ||
57 | <p align="center"> | |
45ef55fc | 58 | <a href="https://peertube.cpy.re"> |
908f6e5e | 59 | <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" /> |
d31910dd C |
60 | </a> |
61 | </p> | |
15e3cdaa | 62 | |
b4b3e77d C |
63 | <p align="center"> |
64 | <strong><a title="Website" target="_blank" href="https://joinpeertube.org">Website</a> | | |
65 | <a title="Instances list" target="_blank" href="https://instances.joinpeertube.org">Instances list</a> | |
66 | </strong> | |
67 | </p> | |
68 | ||
15e3cdaa C |
69 | ## Demonstration |
70 | ||
e755a63a | 71 | Want to see it in action? |
1d1b7891 | 72 | |
63bfad7e | 73 | * Demonstration servers: |
e8395f02 | 74 | * [peertube.cpy.re](http://peertube.cpy.re) |
75 | * [peertube2.cpy.re](http://peertube2.cpy.re) | |
63bfad7e | 76 | * [peertube3.cpy.re](http://peertube3.cpy.re) |
e755a63a | 77 | * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) |
6139124c | 78 | to see what the "decentralization feature" looks like |
b4b3e77d C |
79 | * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see |
80 | the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) | |
15e3cdaa | 81 | |
88c8d458 C |
82 | ## Why |
83 | ||
e755a63a BB |
84 | We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, |
85 | Vimeo... with a centralized software. One organization alone may not have | |
86 | enough money to pay for bandwidth and video storage of its servers. | |
88c8d458 | 87 | |
e755a63a BB |
88 | So we need to have a decentralized network of servers seeding videos (as |
89 | [Diaspora](https://github.com/diaspora/diaspora) for example). But it's not | |
90 | enough because one video could become famous and overload the server. It's the | |
91 | reason why we need to use a P2P protocol to limit the server load. Thanks to | |
92 | [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus | |
63bfad7e | 93 | BitTorrent) inside the web browser, as of today. |
88c8d458 | 94 | |
63bfad7e | 95 | ## Dependencies |
8c308c2b | 96 | |
63bfad7e C |
97 | * nginx |
98 | * PostgreSQL | |
94a5ff8a | 99 | * Redis |
9a989f81 | 100 | * **NodeJS >= 8.x** |
85cd99dc | 101 | * yarn |
8c308c2b | 102 | * OpenSSL (cli) |
99402413 | 103 | * **FFmpeg >= 3.x** |
8c308c2b | 104 | |
e8395f02 | 105 | ## Run using Docker |
106 | ||
4df6a1b8 | 107 | See the [docker guide](/support/doc/docker.md) |
e8395f02 | 108 | |
63bfad7e | 109 | ## Production |
94171ec5 | 110 | |
4df6a1b8 | 111 | See the [production guide](/support/doc/production.md). |
94171ec5 | 112 | |
35501c0f | 113 | ## Contributing/Test |
6dde6a31 | 114 | |
e755a63a | 115 | See the [contributing |
afe81767 | 116 | guide](/.github/CONTRIBUTING.md) |
35501c0f | 117 | to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a |
e755a63a | 118 | coder to help! |
6dde6a31 | 119 | |
d59a8da8 C |
120 | ## API REST documentation |
121 | ||
122 | For now only on Github: | |
123 | ||
9e841674 | 124 | * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html) |
d59a8da8 C |
125 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) |
126 | ||
35501c0f C |
127 | ## Tools |
128 | ||
358770db C |
129 | * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) |
130 | * [Upload videos from the CLI](/support/doc/tools.md) | |
35501c0f | 131 | |
28e014c0 C |
132 | ## FAQ |
133 | ||
134 | If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. | |
135 | ||
8c308c2b C |
136 | ## Architecture |
137 | ||
afe81767 | 138 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. |
241abd69 | 139 | |
8c308c2b C |
140 | ### Backend |
141 | ||
e755a63a BB |
142 | * The backend is a REST API. |
143 | * Servers communicate with each others with [Activity | |
144 | Pub](https://www.w3.org/TR/activitypub/). | |
145 | * Each server has its own users who query it (search videos, query where the | |
146 | torrent URI of this specific video is...). | |
147 | * If a user uploads a video, the server seeds it and sends its followers some | |
148 | metadata (name, short description, torrent URI...). | |
149 | * A server is a tracker responsible for all the videos uploaded in it. | |
150 | * Even if nobody watches a video, it is seeded by the server (through | |
151 | [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the | |
152 | video was uploaded. | |
8c308c2b C |
153 | |
154 | Here are some simple schemes: | |
155 | ||
d3b52378 C |
156 | <p align="center"> |
157 | ||
a988e81c | 158 | <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" /> |
d3b52378 | 159 | |
a988e81c | 160 | <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" /> |
8c308c2b | 161 | |
a988e81c | 162 | <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" /> |
8c308c2b | 163 | |
d3b52378 | 164 | </p> |
5a649344 T |
165 | |
166 | ## License | |
167 | ||
168 | Copyright (C) 2018 PeerTube Contributors | |
169 | ||
170 | This program is free software: you can redistribute it and/or modify | |
171 | it under the terms of the GNU Affero General Public License as published | |
172 | by the Free Software Foundation, either version 3 of the License, or | |
173 | (at your option) any later version. | |
174 | ||
175 | This program is distributed in the hope that it will be useful, | |
176 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
177 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
178 | GNU Affero General Public License for more details. | |
179 | ||
180 | You should have received a copy of the GNU Affero General Public License | |
181 | along with this program. If not, see <http://www.gnu.org/licenses/>. |