]>
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 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 <a href="https://github.com/Chocobozzz/PeerTube/milestone/1">the corresponding milestone</a> and help its development!</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 | </p> | |
53 | ||
54 | <br /> | |
55 | ||
56 | <p align="center"> | |
57 | <a href="https://peertube.cpy.re"> | |
58 | <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" /> | |
59 | </a> | |
60 | </p> | |
61 | ||
62 | ## Getting Started | |
63 | ||
64 | * **[Website](https://joinpeertube.org)** | |
65 | * **[Instances list](https://instances.joinpeertube.org)** | |
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)** | |
69 | ||
70 | ## Demonstration | |
71 | ||
72 | Want to see it in action? | |
73 | ||
74 | * Demonstration servers: | |
75 | * [peertube.cpy.re](https://peertube.cpy.re) | |
76 | * [peertube2.cpy.re](https://peertube2.cpy.re) | |
77 | * [peertube3.cpy.re](https://peertube3.cpy.re) | |
78 | * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) What is PeerTube? | |
79 | * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) | |
80 | to see what the "decentralization feature" looks like | |
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) | |
83 | ||
84 | ## Why | |
85 | ||
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. | |
89 | ||
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. That is | |
93 | 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 | |
95 | BitTorrent) inside the web browser, as of today. | |
96 | ||
97 | ## Dependencies | |
98 | ||
99 | * nginx | |
100 | * PostgreSQL | |
101 | * Redis | |
102 | * **NodeJS >= 8.x** | |
103 | * yarn | |
104 | * OpenSSL (cli) | |
105 | * **FFmpeg >= 3.x** | |
106 | ||
107 | ## Run in production | |
108 | ||
109 | See the [production guide](/support/doc/production.md). | |
110 | ||
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 | ||
114 | Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh). | |
115 | ||
116 | ## Run using Docker | |
117 | ||
118 | See the [docker guide](/support/doc/docker.md). | |
119 | ||
120 | ## Contribute/Translate/Test | |
121 | ||
122 | See the [contributing | |
123 | guide](/.github/CONTRIBUTING.md) | |
124 | to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a | |
125 | coder to help! | |
126 | ||
127 | ## API REST documentation | |
128 | ||
129 | Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) | |
130 | ||
131 | Endpoints documentation: | |
132 | ||
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) | |
134 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) | |
135 | ||
136 | ## Tools | |
137 | ||
138 | * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) | |
139 | * [Upload videos from the CLI](/support/doc/tools.md) | |
140 | * [Admin server tools (create transcoding jobs, prune storage...)](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md#server-tools) | |
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 on 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/>. |