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