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 *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
  76 ## Why
  77
  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.
  81
  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
  87 BitTorrent) inside the web browser, as of today.
  88
  89 ## Features
  90
  91 - [X] Angular frontend
  92 - [X] Join the fediverse
  93   - [X] Follow other instances
  94   - [X] Unfollow an instance
  95   - [X] Get for the followers/following list
  96 - [X] Upload a video
  97   - [X] Seed the video
  98   - [X] Send the meta data with ActivityPub to followers
  99 - [X] Remove the video
 100 - [X] List the videos
 101 - [X] View the video in an HTML5 player with WebTorrent
 102 - [X] Admin panel
 103 - [X] OpenGraph tags
 104 - [X] OEmbed
 105 - [X] Update video
 106 - [X] Federated videos view counter
 107 - [X] Federated videos likes/dislikes
 108 - [X] Transcoding to different definitions
 109 - [X] Download file/torrent
 110 - [X] User video bytes quota
 111 - [X] User video channels
 112 - [X] NSFW warnings/settings
 113 - [X] Video description in markdown
 114 - [X] User roles (administrator, moderator)
 115 - [X] User registration
 116 - [X] Video privacy settings (public, unlisted or private)
 117 - [X] Signaling a video to the admin origin PeerTube instance
 118 - [X] Federated videos comments
 119 - [ ] Video imports (URL, Torrent, YouTube...)
 120 - [ ] Advanced search
 121 - [ ] Subtitles
 122 - [ ] User playlist
 123 - [ ] User subscriptions (by tags, author...)
 124 - [ ] Add "DDOS" security
 125
 126
 127 ## Front compatibility
 128
 129   * Firefox
 130   * Chrome/Chromium
 131
 132 ## Dependencies
 133
 134   * nginx
 135   * PostgreSQL
 136   * Redis
 137   * **NodeJS >= 8.x**
 138   * yarn
 139   * OpenSSL (cli)
 140   * FFmpeg
 141
 142 ## Run using Docker
 143
 144 See the [docker guide](/support/doc/docker.md)
 145
 146 ## Production
 147
 148 See the [production guide](/support/doc/production.md).
 149
 150 ## Contributing
 151
 152 See the [contributing
 153 guide](/.github/CONTRIBUTING.md)
 154 to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
 155 coder to help!
 156
 157 ## API REST documentation
 158
 159 For now only on Github:
 160
 161  * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html)
 162  * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
 163
 164 ## Architecture
 165
 166 See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
 167
 168 ### Backend
 169
 170   * The backend is a REST API.
 171   * Servers communicate with each others with [Activity
 172     Pub](https://www.w3.org/TR/activitypub/).
 173   * Each server has its own users who query it (search videos, query where the
 174     torrent URI of this specific video is...).
 175   * If a user uploads a video, the server seeds it and sends its followers some
 176     metadata (name, short description, torrent URI...).
 177   * A server is a tracker responsible for all the videos uploaded in it.
 178   * Even if nobody watches a video, it is seeded by the server (through
 179     [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
 180     video was uploaded.
 181
 182 Here are some simple schemes:
 183
 184 <p align="center">
 185
 186 <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
 187
 188 <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
 189
 190 <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
 191
 192 </p>