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