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>.
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
13 donating to them](https://soutenir.framasoft.org/en/).**
16 <strong>Client</strong>
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" />
24 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev">
25 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
30 <strong>Server</strong>
34 <a href="https://travis-ci.org/Chocobozzz/PeerTube">
35 <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
38 <a href="https://david-dm.org/Chocobozzz/PeerTube">
39 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
42 <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev">
43 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
46 <a href="http://standardjs.com/">
47 <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
50 <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
51 <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
58 <a href="https://peertube.cpy.re">
59 <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" />
65 Want to see it in action?
67 * Demonstration servers:
68 * [peertube.cpy.re](http://peertube.cpy.re)
69 * [peertube2.cpy.re](http://peertube2.cpy.re)
70 * [peertube3.cpy.re](http://peertube3.cpy.re)
71 * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
72 to see what the "decentralization feature" looks like
76 We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
77 Vimeo... with a centralized software. One organization alone may not have
78 enough money to pay for bandwidth and video storage of its servers.
80 So we need to have a decentralized network of servers seeding videos (as
81 [Diaspora](https://github.com/diaspora/diaspora) for example). But it's not
82 enough because one video could become famous and overload the server. It's the
83 reason why we need to use a P2P protocol to limit the server load. Thanks to
84 [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
85 BitTorrent) inside the web browser, as of today.
99 See the [docker guide](/support/doc/docker.md)
103 See the [production guide](/support/doc/production.md).
107 See the [contributing
108 guide](/.github/CONTRIBUTING.md)
109 to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a
112 ## API REST documentation
114 For now only on Github:
116 * 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)
117 * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
121 * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
122 * [Upload videos from the CLI](/support/doc/tools.md)
126 If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
130 See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
134 * The backend is a REST API.
135 * Servers communicate with each others with [Activity
136 Pub](https://www.w3.org/TR/activitypub/).
137 * Each server has its own users who query it (search videos, query where the
138 torrent URI of this specific video is...).
139 * If a user uploads a video, the server seeds it and sends its followers some
140 metadata (name, short description, torrent URI...).
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 (through
143 [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
146 Here are some simple schemes:
150 <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
152 <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
154 <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
160 Copyright (C) 2018 PeerTube Contributors
162 This program is free software: you can redistribute it and/or modify
163 it under the terms of the GNU Affero General Public License as published
164 by the Free Software Foundation, either version 3 of the License, or
165 (at your option) any later version.
167 This program is distributed in the hope that it will be useful,
168 but WITHOUT ANY WARRANTY; without even the implied warranty of
169 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
170 GNU Affero General Public License for more details.
172 You should have received a copy of the GNU Affero General Public License
173 along with this program. If not, see <http://www.gnu.org/licenses/>.