Add api documentation in readme
[oweals/peertube.git] / README.md
1 <h1 align="center">
2   PeerTube
3 </h1>
4
5 <h4 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 </h4>
9
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
13 donating to them](https://soutenir.framasoft.org/en/).**
14
15 <p align="center">
16   <strong>Client</strong>
17
18   <br />
19
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
24   <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev">
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">
35     <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
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
42   <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev">
43     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
44   </a>
45
46   <a href="http://standardjs.com/">
47     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
48   </a>
49
50   <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
51     <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
52   </a>
53 </p>
54
55 <br />
56
57 <p align="center">
58   <a href="https://peertube.cpy.re">
59     <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" />
60   </a>
61 </p>
62
63 ## Demonstration
64
65 Want to see it in action?
66
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)
71    * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
72      to see what the "decentralization feature" looks like
73
74 ## Why
75
76 We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
77 Vimeo... with a centralized software. One organization alone may not have
78 enough money to pay for bandwidth and video storage of its servers.
79
80 So 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
82 enough because one video could become famous and overload the server.  It's the
83 reason 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
85 BitTorrent) inside the web browser, as of today.
86
87 ## Features
88
89 - [X] Angular frontend
90 - [X] Join the fediverse
91   - [X] Follow other instances
92   - [X] Unfollow an instance
93   - [X] Get for the followers/following list
94 - [X] Upload a video
95   - [X] Seed the video
96   - [X] Send the meta data with ActivityPub to followers
97 - [X] Remove the video
98 - [X] List the videos
99 - [X] View the video in an HTML5 player with WebTorrent
100 - [X] Admin panel
101 - [X] OpenGraph tags
102 - [X] OEmbed
103 - [X] Update video
104 - [X] Federated videos view counter
105 - [X] Federated videos likes/dislikes
106 - [X] Transcoding to different definitions
107 - [X] Download file/torrent
108 - [X] User video bytes quota
109 - [X] User video channels
110 - [X] NSFW warnings/settings
111 - [X] Video description in markdown
112 - [X] User roles (administrator, moderator)
113 - [X] User registration
114 - [X] Video privacy settings (public, unlisted or private)
115 - [X] Signaling a video to the admin origin PeerTube instance
116 - [X] Federated videos comments
117 - [ ] Video imports (URL, Torrent, YouTube...)
118 - [ ] Advanced search
119 - [ ] Subtitles
120 - [ ] User playlist
121 - [ ] User subscriptions (by tags, author...)
122 - [ ] Add "DDOS" security
123
124
125 ## Front compatibility
126
127   * Firefox
128   * Chrome/Chromium
129
130 ## Dependencies
131
132   * nginx
133   * PostgreSQL
134   * **NodeJS >= 8.x**
135   * yarn
136   * OpenSSL (cli)
137   * FFmpeg
138
139 ## Production
140
141 See the [production guide](support/doc/production.md).
142
143 ## Contributing
144
145 See the [contributing
146 guide](/.github/CONTRIBUTING.md)
147 to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
148 coder to help!
149
150 ## API REST documentation
151
152 For now only on Github:
153
154  * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html)
155  * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
156
157 ## Architecture
158
159 See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
160
161 ### Backend
162
163   * The backend is a REST API.
164   * Servers communicate with each others with [Activity
165     Pub](https://www.w3.org/TR/activitypub/).
166   * Each server has its own users who query it (search videos, query where the
167     torrent URI of this specific video is...).
168   * If a user uploads a video, the server seeds it and sends its followers some
169     metadata (name, short description, torrent URI...).
170   * A server is a tracker responsible for all the videos uploaded in it.
171   * Even if nobody watches a video, it is seeded by the server (through
172     [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
173     video was uploaded.
174
175 Here are some simple schemes:
176
177 <p align="center">
178
179 <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
180
181 <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
182
183 <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
184
185 </p>