]>
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 | |
e755a63a BB |
10 | **PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit |
11 | that promotes, spreads and develops free culture in general, and free-libre | |
12 | software in 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> | |
27 | </p> | |
28 | ||
29 | <p align="center"> | |
30 | <strong>Server</strong> | |
31 | ||
32 | <br /> | |
33 | ||
34 | <a href="https://travis-ci.org/Chocobozzz/PeerTube"> | |
13fc89f4 | 35 | <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" /> |
d3b52378 C |
36 | </a> |
37 | ||
38 | <a href="https://david-dm.org/Chocobozzz/PeerTube"> | |
39 | <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" /> | |
40 | </a> | |
41 | ||
c27c3a27 | 42 | <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev"> |
d3b52378 C |
43 | <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" /> |
44 | </a> | |
45 | ||
d31910dd C |
46 | <a href="http://standardjs.com/"> |
47 | <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" /> | |
d3b52378 | 48 | </a> |
80deae8d | 49 | |
5cefff7d | 50 | <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube"> |
fcc5f77b | 51 | <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" /> |
5cefff7d | 52 | </a> |
d3b52378 | 53 | </p> |
b4c5a1f8 | 54 | |
d31910dd C |
55 | <br /> |
56 | ||
57 | <p align="center"> | |
45ef55fc | 58 | <a href="https://peertube.cpy.re"> |
908f6e5e | 59 | <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" /> |
d31910dd C |
60 | </a> |
61 | </p> | |
15e3cdaa C |
62 | |
63 | ## Demonstration | |
64 | ||
e755a63a | 65 | Want to see it in action? |
1d1b7891 | 66 | |
63bfad7e | 67 | * Demonstration servers: |
e8395f02 | 68 | * [peertube.cpy.re](http://peertube.cpy.re) |
69 | * [peertube2.cpy.re](http://peertube2.cpy.re) | |
63bfad7e | 70 | * [peertube3.cpy.re](http://peertube3.cpy.re) |
e755a63a | 71 | * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) |
6139124c | 72 | to see what the "decentralization feature" looks like |
15e3cdaa | 73 | |
7859b580 C |
74 | *Currently PeerTube is still in alpha (we plan to release a beta in march). Demonstration servers do not support public registration. If you really want to test PeerTube before the public release, here is a list of PeerTube servers: https://github.com/Chocobozzz/PeerTube/wiki#other-peertube-servers.* |
75 | ||
88c8d458 C |
76 | ## Why |
77 | ||
e755a63a BB |
78 | We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, |
79 | Vimeo... with a centralized software. One organization alone may not have | |
80 | enough money to pay for bandwidth and video storage of its servers. | |
88c8d458 | 81 | |
e755a63a BB |
82 | So we need to have a decentralized network of servers seeding videos (as |
83 | [Diaspora](https://github.com/diaspora/diaspora) for example). But it's not | |
84 | enough because one video could become famous and overload the server. It's the | |
85 | reason why we need to use a P2P protocol to limit the server load. Thanks to | |
86 | [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus | |
63bfad7e | 87 | BitTorrent) inside the web browser, as of today. |
88c8d458 | 88 | |
8c308c2b C |
89 | ## Features |
90 | ||
63bfad7e | 91 | - [X] Angular frontend |
fcaf1e0a C |
92 | - [X] Join the fediverse |
93 | - [X] Follow other instances | |
94 | - [X] Unfollow an instance | |
95 | - [X] Get for the followers/following list | |
8c308c2b C |
96 | - [X] Upload a video |
97 | - [X] Seed the video | |
fcaf1e0a | 98 | - [X] Send the meta data with ActivityPub to followers |
8c308c2b C |
99 | - [X] Remove the video |
100 | - [X] List the videos | |
fcaf1e0a | 101 | - [X] View the video in an HTML5 player with WebTorrent |
19a08a34 | 102 | - [X] Admin panel |
900f0d2b | 103 | - [X] OpenGraph tags |
604e02ab | 104 | - [X] OEmbed |
00871a26 | 105 | - [X] Update video |
63bfad7e C |
106 | - [X] Federated videos view counter |
107 | - [X] Federated videos likes/dislikes | |
604e02ab C |
108 | - [X] Transcoding to different definitions |
109 | - [X] Download file/torrent | |
110 | - [X] User video bytes quota | |
fcaf1e0a | 111 | - [X] User video channels |
604e02ab C |
112 | - [X] NSFW warnings/settings |
113 | - [X] Video description in markdown | |
114 | - [X] User roles (administrator, moderator) | |
00871a26 | 115 | - [X] User registration |
604e02ab | 116 | - [X] Video privacy settings (public, unlisted or private) |
fcaf1e0a | 117 | - [X] Signaling a video to the admin origin PeerTube instance |
63bfad7e | 118 | - [X] Federated videos comments |
20b40b19 C |
119 | - [X] Update video thumbnails |
120 | - [X] Support video uploader button | |
63bfad7e C |
121 | - [ ] Video imports (URL, Torrent, YouTube...) |
122 | - [ ] Advanced search | |
123 | - [ ] Subtitles | |
604e02ab C |
124 | - [ ] User playlist |
125 | - [ ] User subscriptions (by tags, author...) | |
fcaf1e0a | 126 | - [ ] Add "DDOS" security |
00871a26 | 127 | |
8c308c2b | 128 | |
63bfad7e | 129 | ## Front compatibility |
8c308c2b | 130 | |
63bfad7e C |
131 | * Firefox |
132 | * Chrome/Chromium | |
199cef3a | 133 | |
63bfad7e | 134 | ## Dependencies |
8c308c2b | 135 | |
63bfad7e C |
136 | * nginx |
137 | * PostgreSQL | |
94a5ff8a | 138 | * Redis |
9a989f81 | 139 | * **NodeJS >= 8.x** |
85cd99dc | 140 | * yarn |
8c308c2b | 141 | * OpenSSL (cli) |
99402413 | 142 | * **FFmpeg >= 3.x** |
8c308c2b | 143 | |
e8395f02 | 144 | ## Run using Docker |
145 | ||
4df6a1b8 | 146 | See the [docker guide](/support/doc/docker.md) |
e8395f02 | 147 | |
63bfad7e | 148 | ## Production |
94171ec5 | 149 | |
4df6a1b8 | 150 | See the [production guide](/support/doc/production.md). |
94171ec5 | 151 | |
35501c0f | 152 | ## Contributing/Test |
6dde6a31 | 153 | |
e755a63a | 154 | See the [contributing |
afe81767 | 155 | guide](/.github/CONTRIBUTING.md) |
35501c0f | 156 | to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a |
e755a63a | 157 | coder to help! |
6dde6a31 | 158 | |
d59a8da8 C |
159 | ## API REST documentation |
160 | ||
161 | For now only on Github: | |
162 | ||
163 | * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) | |
164 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) | |
165 | ||
35501c0f C |
166 | ## Tools |
167 | ||
358770db C |
168 | * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) |
169 | * [Upload videos from the CLI](/support/doc/tools.md) | |
35501c0f | 170 | |
28e014c0 C |
171 | ## FAQ |
172 | ||
173 | If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. | |
174 | ||
8c308c2b C |
175 | ## Architecture |
176 | ||
afe81767 | 177 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. |
241abd69 | 178 | |
8c308c2b C |
179 | ### Backend |
180 | ||
e755a63a BB |
181 | * The backend is a REST API. |
182 | * Servers communicate with each others with [Activity | |
183 | Pub](https://www.w3.org/TR/activitypub/). | |
184 | * Each server has its own users who query it (search videos, query where the | |
185 | torrent URI of this specific video is...). | |
186 | * If a user uploads a video, the server seeds it and sends its followers some | |
187 | metadata (name, short description, torrent URI...). | |
188 | * A server is a tracker responsible for all the videos uploaded in it. | |
189 | * Even if nobody watches a video, it is seeded by the server (through | |
190 | [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the | |
191 | video was uploaded. | |
8c308c2b C |
192 | |
193 | Here are some simple schemes: | |
194 | ||
d3b52378 C |
195 | <p align="center"> |
196 | ||
a988e81c | 197 | <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" /> |
d3b52378 | 198 | |
a988e81c | 199 | <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" /> |
8c308c2b | 200 | |
a988e81c | 201 | <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" /> |
8c308c2b | 202 | |
d3b52378 | 203 | </p> |