README.md

   1 <h1 align="center">
   2   PeerTube
   3 </h1>
   4
   5 <h4 align="center">
   6 Decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
   7 </h4>
   8
   9 <p align="center">
  10   <strong>Client</strong>
  11
  12   <br />
  13
  14   <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
  15     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
  16   </a>
  17
  18   <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
  19     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
  20   </a>
  21 </p>
  22
  23 <p align="center">
  24   <strong>Server</strong>
  25
  26   <br />
  27
  28   <a href="https://travis-ci.org/Chocobozzz/PeerTube">
  29     <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
  30   </a>
  31
  32   <a href="https://david-dm.org/Chocobozzz/PeerTube">
  33     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
  34   </a>
  35
  36   <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
  37     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
  38   </a>
  39
  40   <a href="http://standardjs.com/">
  41     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
  42   </a>
  43
  44   <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
  45     <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
  46   </a>
  47 </p>
  48
  49 <br />
  50
  51 <p align="center">
  52   <a href="https://peertube.cpy.re">
  53     <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
  54   </a>
  55 </p>
  56
  57 ## Demonstration
  58
  59 Want to see in action?
  60
  61    * [Demo server](http://peertube.cpy.re)
  62    * [Video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
  63    * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly.
  64
  65 ## Why
  66
  67 We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enought money to pay bandwith and video storage of its server.
  68
  69 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
  70 But it's not enought because one video could become famous and overload the server.
  71 It's the reason why we need to use a P2P protocol to limit the server load.
  72 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
  73
  74 ## Features
  75
  76 - [X] Frontend
  77   - [X] Angular frontend
  78 - [X] Join a network
  79   - [X] Generate a RSA key
  80   - [X] Ask for the friend list of other pods and make friend with them
  81   - [X] Get the list of the videos owned by a pod when making friend with it
  82   - [X] Post the list of its own videos when making friend with another pod
  83 - [X] Quit a network
  84 - [X] Upload a video
  85   - [X] Seed the video
  86   - [X] Send the meta data to all other friends
  87 - [X] Remove the video
  88 - [X] List the videos
  89 - [X] Search a video name (local index)
  90 - [X] View the video in an HTML5 page with WebTorrent
  91 - [X] Manage admin account
  92   - [X] Connection
  93   - [X] Account rights (upload...)
  94 - [X] Make the network auto sufficient (eject bad pods etc)
  95 - [X] Validate the prototype (test PeerTube in a real world)
  96 - [ ] Manage inter pod API breaks
  97 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
  98 - [X] Admin panel
  99   - [X] Stats
 100   - [X] Friends list
 101   - [X] Manage users (create/remove)
 102 - [X] OpenGraph tags
 103 - [X] Update video
 104 - [X] Videos view count
 105 - [X] Videos likes/dislikes
 106 - [ ] Videos comments?
 107 - [X] User registration
 108 - [ ] User playlists
 109 - [ ] User subscriptions (by tags, author...)
 110 - [X] Signaling a video to the admin origin pod
 111
 112
 113 ## Installation
 114
 115 See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
 116
 117 ### Front compatibility
 118
 119   * Chromium
 120   * Firefox (>= 42 for MediaSource support)
 121
 122 ### Dependencies
 123
 124   * **NodeJS >= 6.x**
 125   * **npm >= 3.x**
 126   * yarn
 127   * OpenSSL (cli)
 128   * PostgreSQL
 129   * FFmpeg
 130
 131 #### Debian
 132
 133   * Install NodeJS 6.x (actual LTS): [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
 134   * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
 135   * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
 136   * Run:
 137
 138         # apt-get update
 139         # apt-get install ffmpeg postgresql-9.4 openssl
 140
 141 #### Other distribution... (PR welcome)
 142
 143
 144 ### Sources
 145
 146     $ git clone -b master https://github.com/Chocobozzz/PeerTube
 147     $ cd PeerTube
 148     $ yarn install
 149     $ npm run build
 150
 151 ## Usage
 152
 153 ### Production
 154
 155 If you want to run PeerTube for production (bad idea for now :) ):
 156
 157     $ cp config/production.yaml.example config/production.yaml
 158
 159 Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
 160
 161 Finally, run the server with the `production` `NODE_ENV` variable set.
 162
 163     $ NODE_ENV=production npm start
 164
 165 The administrator password is automatically generated and can be found in the logs. You can set another password with:
 166
 167     $ NODE_ENV=production npm run reset-password -- -u root
 168
 169 **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
 170 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
 171
 172 You can check the application (CORS headers, tracker websocket...) by running:
 173
 174     $ NODE_ENV=production npm run check
 175
 176 ### Upgrade
 177
 178 The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
 179
 180     # systemctl stop peertube
 181     $ npm run upgrade
 182     # systemctl start peertube
 183
 184 ### Development
 185
 186 In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them:
 187
 188     $ npm run dev
 189
 190 **Username**: *root* <br/>
 191 **Password**: *test*
 192
 193 ### Test with 3 fresh nodes
 194
 195     $ npm run clean:server:test
 196     $ npm run play
 197
 198 Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
 199
 200 ### Other commands
 201
 202 To print all available command run:
 203
 204     $ npm run help
 205
 206 ## Dockerfile
 207
 208 You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
 209
 210 ## Contributing
 211
 212 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
 213
 214 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
 215
 216 See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
 217
 218
 219 ## Architecture
 220
 221 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
 222
 223 ### Backend
 224
 225   * The backend is a REST API
 226   * Servers communicate with each others through it
 227     * A network is composed by servers that communicate between them
 228     * Each server of a network has a list of all other servers of this network
 229     * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list
 230     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
 231     * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
 232     * Each server has a RSA key to encrypt and sign communications with other servers
 233   * A server is a tracker responsible for all the videos uploaded in it
 234   * Even if nobody watches a video, it is seeded by the server (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
 235   * A network can live and evolve by expelling bad pod (with too many downtimes for example)
 236
 237 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
 238
 239 Here are some simple schemes:
 240
 241 <p align="center">
 242
 243 <img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
 244
 245 <img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
 246
 247 <img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
 248
 249 <img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
 250
 251 <img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
 252
 253 </p>
 254
 255 ### Frontend
 256
 257 There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
 258 The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.