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