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