]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - README.md
Add api doc in html
[github/Chocobozzz/PeerTube.git] / README.md
CommitLineData
d3b52378
C
1<h1 align="center">
2 PeerTube
3</h1>
8c308c2b 4
d3b52378 5<h4 align="center">
e755a63a
BB
6Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
7directly 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
11that promotes, spreads and develops free culture in general, and free-libre
12software in particular. If you want to support this project, please [consider
6139124c 13donating 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 65Want to see it in action?
1d1b7891 66
63bfad7e
C
67 * Demonstration servers:
68 * [peertube.cpy.re](http://peertube.cpy.re)
69 * [peertube2.cpy.re](http://peertube2.cpy.re)
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
88c8d458
C
74## Why
75
e755a63a
BB
76We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
77Vimeo... with a centralized software. One organization alone may not have
78enough money to pay for bandwidth and video storage of its servers.
88c8d458 79
e755a63a
BB
80So we need to have a decentralized network of servers seeding videos (as
81[Diaspora](https://github.com/diaspora/diaspora) for example). But it's not
82enough because one video could become famous and overload the server. It's the
83reason why we need to use a P2P protocol to limit the server load. Thanks to
84[WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
63bfad7e 85BitTorrent) inside the web browser, as of today.
88c8d458 86
8c308c2b
C
87## Features
88
63bfad7e 89- [X] Angular frontend
fcaf1e0a
C
90- [X] Join the fediverse
91 - [X] Follow other instances
92 - [X] Unfollow an instance
93 - [X] Get for the followers/following list
8c308c2b
C
94- [X] Upload a video
95 - [X] Seed the video
fcaf1e0a 96 - [X] Send the meta data with ActivityPub to followers
8c308c2b
C
97- [X] Remove the video
98- [X] List the videos
fcaf1e0a 99- [X] View the video in an HTML5 player with WebTorrent
19a08a34 100- [X] Admin panel
900f0d2b 101- [X] OpenGraph tags
604e02ab 102- [X] OEmbed
00871a26 103- [X] Update video
63bfad7e
C
104- [X] Federated videos view counter
105- [X] Federated videos likes/dislikes
604e02ab
C
106- [X] Transcoding to different definitions
107- [X] Download file/torrent
108- [X] User video bytes quota
fcaf1e0a 109- [X] User video channels
604e02ab
C
110- [X] NSFW warnings/settings
111- [X] Video description in markdown
112- [X] User roles (administrator, moderator)
00871a26 113- [X] User registration
604e02ab 114- [X] Video privacy settings (public, unlisted or private)
fcaf1e0a 115- [X] Signaling a video to the admin origin PeerTube instance
63bfad7e
C
116- [X] Federated videos comments
117- [ ] Video imports (URL, Torrent, YouTube...)
118- [ ] Advanced search
119- [ ] Subtitles
604e02ab
C
120- [ ] User playlist
121- [ ] User subscriptions (by tags, author...)
fcaf1e0a 122- [ ] Add "DDOS" security
00871a26 123
8c308c2b 124
63bfad7e 125## Front compatibility
8c308c2b 126
63bfad7e
C
127 * Firefox
128 * Chrome/Chromium
199cef3a 129
63bfad7e 130## Dependencies
8c308c2b 131
63bfad7e
C
132 * nginx
133 * PostgreSQL
9a989f81 134 * **NodeJS >= 8.x**
85cd99dc 135 * yarn
8c308c2b 136 * OpenSSL (cli)
80deae8d 137 * FFmpeg
8c308c2b 138
63bfad7e 139## Production
94171ec5 140
63bfad7e 141See the [production guide](support/doc/production.md).
94171ec5 142
6dde6a31
C
143## Contributing
144
e755a63a 145See the [contributing
afe81767 146guide](/.github/CONTRIBUTING.md)
e755a63a
BB
147to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
148coder to help!
6dde6a31 149
8c308c2b
C
150## Architecture
151
afe81767 152See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
241abd69 153
8c308c2b
C
154### Backend
155
e755a63a
BB
156 * The backend is a REST API.
157 * Servers communicate with each others with [Activity
158 Pub](https://www.w3.org/TR/activitypub/).
159 * Each server has its own users who query it (search videos, query where the
160 torrent URI of this specific video is...).
161 * If a user uploads a video, the server seeds it and sends its followers some
162 metadata (name, short description, torrent URI...).
163 * A server is a tracker responsible for all the videos uploaded in it.
164 * Even if nobody watches a video, it is seeded by the server (through
165 [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
166 video was uploaded.
8c308c2b
C
167
168Here are some simple schemes:
169
d3b52378
C
170<p align="center">
171
a988e81c 172<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
d3b52378 173
a988e81c 174<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
8c308c2b 175
a988e81c 176<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
8c308c2b 177
d3b52378 178</p>