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 developed by [Framasoft](https://framasoft.org/?l=en), a non-profit
  11 that promotes and spreads free culture in general, and free-libre software in
  12 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 <p align="center">
  64   <strong><a title="Website" target="_blank" href="https://joinpeertube.org">Website</a> |
  65   <a title="Instances list" target="_blank" href="https://instances.joinpeertube.org">Instances list</a>
  66   </strong>
  67 </p>
  68
  69 ## Demonstration
  70
  71 Want to see it in action?
  72
  73    * Demonstration servers:
  74      * [peertube.cpy.re](http://peertube.cpy.re)
  75      * [peertube2.cpy.re](http://peertube2.cpy.re)
  76      * [peertube3.cpy.re](http://peertube3.cpy.re)
  77    * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
  78      to see what the "decentralization feature" looks like
  79    * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see
  80    the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
  81
  82 ## Why
  83
  84 We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
  85 Vimeo... with a centralized software. One organization alone may not have
  86 enough money to pay for bandwidth and video storage of its servers.
  87
  88 So we need to have a decentralized network of servers seeding videos (as
  89 [Diaspora](https://github.com/diaspora/diaspora) for example).  But it's not
  90 enough because one video could become famous and overload the server.  It's the
  91 reason why we need to use a P2P protocol to limit the server load.  Thanks to
  92 [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
  93 BitTorrent) inside the web browser, as of today.
  94
  95 ## Dependencies
  96
  97   * nginx
  98   * PostgreSQL
  99   * Redis
 100   * **NodeJS >= 8.x**
 101   * yarn
 102   * OpenSSL (cli)
 103   * **FFmpeg >= 3.x**
 104
 105 ## Run using Docker
 106
 107 See the [docker guide](/support/doc/docker.md)
 108
 109 ## Production
 110
 111 See the [production guide](/support/doc/production.md).
 112
 113 ## Contributing/Test
 114
 115 See the [contributing
 116 guide](/.github/CONTRIBUTING.md)
 117 to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a
 118 coder to help!
 119
 120 ## API REST documentation
 121
 122 Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md)
 123
 124 Endpoints documentation:
 125
 126  * 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)
 127  * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
 128
 129 ## Tools
 130
 131  * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
 132  * [Upload videos from the CLI](/support/doc/tools.md)
 133
 134 ## FAQ
 135
 136 If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
 137
 138 ## Architecture
 139
 140 See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
 141
 142 ### Backend
 143
 144   * The backend is a REST API.
 145   * Servers communicate with each others with [Activity
 146     Pub](https://www.w3.org/TR/activitypub/).
 147   * Each server has its own users who query it (search videos, query where the
 148     torrent URI of this specific video is...).
 149   * If a user uploads a video, the server seeds it and sends its followers some
 150     metadata (name, short description, torrent URI...).
 151   * A server is a tracker responsible for all the videos uploaded in it.
 152   * Even if nobody watches a video, it is seeded by the server (through
 153     [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
 154     video was uploaded.
 155
 156 Here are some simple schemes:
 157
 158 <p align="center">
 159
 160 <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
 161
 162 <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
 163
 164 <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
 165
 166 </p>
 167
 168 ## License
 169
 170 Copyright (C) 2018 PeerTube Contributors
 171
 172 This program is free software: you can redistribute it and/or modify
 173 it under the terms of the GNU Affero General Public License as published
 174 by the Free Software Foundation, either version 3 of the License, or
 175 (at your option) any later version.
 176
 177 This program is distributed in the hope that it will be useful,
 178 but WITHOUT ANY WARRANTY; without even the implied warranty of
 179 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 180 GNU Affero General Public License for more details.
 181
 182 You should have received a copy of the GNU Affero General Public License
 183 along with this program.  If not, see <http://www.gnu.org/licenses/>.