]>
Commit | Line | Data |
---|---|---|
d3b52378 C |
1 | <h1 align="center"> |
2 | PeerTube | |
3 | </h1> | |
8c308c2b | 4 | |
f2de393e | 5 | <p 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>. | |
f2de393e | 8 | </p> |
88c8d458 | 9 | |
77a87fec | 10 | <p align="center"> |
106e68cf | 11 | <strong>We have run <a href="https://www.kisskissbankbank.com/en/projects/peertube-a-free-and-federated-video-platform">a crowdfunding campaign</a> to pave the road to version 1.0 of PeerTube. Thanks to everyone who pitched in and shared the news around. You can now check out [the corresponding milestone](https://github.com/Chocobozzz/PeerTube/milestone/1) and help its development!</strong> |
77a87fec | 12 | </p> |
570a60fa | 13 | |
d3b52378 C |
14 | <p align="center"> |
15 | <strong>Client</strong> | |
191ce958 | 16 | |
d3b52378 | 17 | <br /> |
8c308c2b | 18 | |
d3b52378 C |
19 | <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client"> |
20 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" /> | |
21 | </a> | |
22 | ||
c27c3a27 | 23 | <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev"> |
d3b52378 C |
24 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" /> |
25 | </a> | |
5f92c4dc | 26 | |
2e8e97f3 C |
27 | <a href="https://www.browserstack.com/automate/public-build/VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%"> |
28 | <img src='https://www.browserstack.com/automate/badge.svg?badge_key=VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%'/> | |
29 | </a> | |
d3b52378 C |
30 | </p> |
31 | ||
32 | <p align="center"> | |
33 | <strong>Server</strong> | |
34 | ||
35 | <br /> | |
36 | ||
37 | <a href="https://travis-ci.org/Chocobozzz/PeerTube"> | |
13fc89f4 | 38 | <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" /> |
d3b52378 C |
39 | </a> |
40 | ||
41 | <a href="https://david-dm.org/Chocobozzz/PeerTube"> | |
42 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" /> | |
43 | </a> | |
44 | ||
c27c3a27 | 45 | <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev"> |
d3b52378 C |
46 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" /> |
47 | </a> | |
48 | ||
d31910dd C |
49 | <a href="http://standardjs.com/"> |
50 | <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" /> | |
d3b52378 C |
51 | </a> |
52 | </p> | |
b4c5a1f8 | 53 | |
d31910dd C |
54 | <br /> |
55 | ||
56 | <p align="center"> | |
45ef55fc | 57 | <a href="https://peertube.cpy.re"> |
908f6e5e | 58 | <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" /> |
d31910dd C |
59 | </a> |
60 | </p> | |
15e3cdaa | 61 | |
0de51bb1 C |
62 | ## Getting Started |
63 | ||
64 | * **[Website](https://joinpeertube.org)** | |
65 | * **[Instances list](https://instances.joinpeertube.org)** | |
106e68cf RK |
66 | * Chat: |
67 | * **IRC : [#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)** | |
68 | * **Matrix (bridged on the IRC channel) : [#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)** | |
b4b3e77d | 69 | |
15e3cdaa C |
70 | ## Demonstration |
71 | ||
e755a63a | 72 | Want to see it in action? |
1d1b7891 | 73 | |
63bfad7e | 74 | * Demonstration servers: |
d092f5ba BA |
75 | * [peertube.cpy.re](https://peertube.cpy.re) |
76 | * [peertube2.cpy.re](https://peertube2.cpy.re) | |
77 | * [peertube3.cpy.re](https://peertube3.cpy.re) | |
14122085 | 78 | * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) What is PeerTube? |
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 | |
c9e96ead Y |
92 | enough because one video could become famous and overload the server. That is |
93 | why we need to use a P2P protocol to limit the server load. Thanks to | |
e755a63a | 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 | |
106e68cf | 107 | ## Run in production |
e8395f02 | 108 | |
106e68cf | 109 | See the [production guide](/support/doc/production.md). |
e8395f02 | 110 | |
550a562c | 111 | ## Run on YunoHost |
112 | [![Install Peertube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=peertube) | |
113 | ||
106e68cf | 114 | Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh). |
550a562c | 115 | |
106e68cf | 116 | ## Run using Docker |
94171ec5 | 117 | |
106e68cf | 118 | See the [docker guide](/support/doc/docker.md). |
94171ec5 | 119 | |
6a1787c1 | 120 | ## Contribute/Translate/Test |
6dde6a31 | 121 | |
e755a63a | 122 | See the [contributing |
afe81767 | 123 | guide](/.github/CONTRIBUTING.md) |
6a1787c1 | 124 | to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a |
e755a63a | 125 | coder to help! |
6dde6a31 | 126 | |
d59a8da8 C |
127 | ## API REST documentation |
128 | ||
c0c7416a C |
129 | Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) |
130 | ||
131 | Endpoints documentation: | |
d59a8da8 | 132 | |
9e841674 | 133 | * 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 |
134 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) |
135 | ||
35501c0f C |
136 | ## Tools |
137 | ||
358770db C |
138 | * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) |
139 | * [Upload videos from the CLI](/support/doc/tools.md) | |
35501c0f | 140 | |
28e014c0 C |
141 | ## FAQ |
142 | ||
143 | If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. | |
144 | ||
8c308c2b C |
145 | ## Architecture |
146 | ||
afe81767 | 147 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. |
241abd69 | 148 | |
8c308c2b C |
149 | ### Backend |
150 | ||
e755a63a BB |
151 | * The backend is a REST API. |
152 | * Servers communicate with each others with [Activity | |
153 | Pub](https://www.w3.org/TR/activitypub/). | |
154 | * Each server has its own users who query it (search videos, query where the | |
155 | torrent URI of this specific video is...). | |
156 | * If a user uploads a video, the server seeds it and sends its followers some | |
157 | metadata (name, short description, torrent URI...). | |
c9e96ead | 158 | * A server is a tracker responsible for all the videos uploaded on it. |
e755a63a BB |
159 | * Even if nobody watches a video, it is seeded by the server (through |
160 | [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the | |
161 | video was uploaded. | |
8c308c2b C |
162 | |
163 | Here are some simple schemes: | |
164 | ||
d3b52378 C |
165 | <p align="center"> |
166 | ||
a988e81c | 167 | <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" /> |
d3b52378 | 168 | |
a988e81c | 169 | <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" /> |
8c308c2b | 170 | |
a988e81c | 171 | <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" /> |
8c308c2b | 172 | |
d3b52378 | 173 | </p> |
5a649344 T |
174 | |
175 | ## License | |
176 | ||
177 | Copyright (C) 2018 PeerTube Contributors | |
178 | ||
179 | This program is free software: you can redistribute it and/or modify | |
180 | it under the terms of the GNU Affero General Public License as published | |
97b72ed1 RK |
181 | by the Free Software Foundation, either version 3 of the License, or |
182 | (at your option) any later version. | |
5a649344 T |
183 | |
184 | This program is distributed in the hope that it will be useful, | |
185 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
186 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
187 | GNU Affero General Public License for more details. | |
188 | ||
189 | You should have received a copy of the GNU Affero General Public License | |
190 | along with this program. If not, see <http://www.gnu.org/licenses/>. |