README.md

   1 <h1 align="center">
   2   PeerTube
   3 </h1>
   4
   5 <h4 align="center">
   6 Prototype of a 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=devDependencies">
  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=master" 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=devDependencies">
  37     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
  38   </a>
  39
  40   <a href="https://codeclimate.com/github/Chocobozzz/PeerTube">
  41     <img src="https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg" alt="Code climate" />
  42   </a>
  43
  44   <a href="http://standardjs.com/">
  45     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
  46   </a>
  47 </p>
  48
  49 <br />
  50
  51 <p align="center">
  52   <a href="http://peertube.cpy.re">
  53     <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
  54   </a>
  55 </p>
  56
  57 ## Demonstration
  58
  59 Want to see in action?
  60
  61    * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC)
  62    * You can find [a 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] ~~Simple frontend (All elements are generated by jQuery)~~
  78   - [X] Angular 2 frontend
  79 - [X] Join a network
  80   - [X] Generate a RSA key
  81   - [X] Ask for the friend list of other pods and make friend with them
  82   - [X] Get the list of the videos owned by a pod when making friend with it
  83   - [X] Post the list of its own videos when making friend with another pod
  84 - [X] Quit a network
  85 - [X] Upload a video
  86   - [X] Seed the video
  87   - [X] Send the meta data to all other friends
  88 - [X] Remove the video
  89 - [X] List the videos
  90 - [X] Search a video name (local index)
  91 - [X] View the video in an HTML5 page with WebTorrent
  92 - [X] Manage admin account
  93   - [X] Connection
  94   - [X] Account rights (upload...)
  95 - [X] Make the network auto sufficient (eject bad pods etc)
  96 - [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
  97 - [ ] Manage API breaks
  98 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
  99 - [X] Admin panel
 100   - [X] Stats
 101   - [X] Friends list
 102   - [X] Manage users (create/remove)
 103 - [X] OpenGraph tags
 104 - [ ] User playlists
 105 - [ ] User subscriptions (by tags, author...)
 106 - [ ] Signaling a video to the admin pod
 107
 108 ## Installation
 109
 110 ### Front compatibility
 111
 112   * Chromium
 113   * Firefox (>= 42 for MediaSource support)
 114
 115 ### Dependencies
 116
 117   * **NodeJS >= 4.x**
 118   * **npm >= 3.x**
 119   * OpenSSL (cli)
 120   * MongoDB
 121   * ffmpeg
 122
 123 #### Debian
 124
 125   * Install NodeJS 4.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)
 126   * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
 127   * Run:
 128
 129         # apt-get update
 130         # apt-get install ffmpeg mongodb openssl
 131         # npm install -g npm@3
 132
 133 #### Other distribution... (PR welcome)
 134
 135
 136 ### Sources
 137
 138     $ git clone https://github.com/Chocobozzz/PeerTube
 139     $ cd PeerTube
 140     $ npm install # Or npm install --unsafe-perm for root user
 141     $ npm run build
 142
 143 ## Usage
 144
 145 ### Development
 146
 147     $ npm run dev
 148
 149 ### Test with 3 fresh nodes
 150
 151     $ npm run clean:server:test
 152     $ npm run play
 153
 154 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 :)
 155
 156 ### Production
 157
 158 If you want to run PeerTube for production (bad idea for now :) ):
 159
 160     $ cp config/production.yaml.example config/production.yaml
 161
 162 Then edit the `config/production.yaml` file according to your webserver configuration.
 163
 164 Finally, run the server with the `production` `NODE_ENV` variable set.
 165
 166     $ NODE_ENV=production npm start
 167
 168 **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
 169
 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 ### Other commands
 185
 186 To print all available command run:
 187
 188     $ npm run help
 189
 190 ## Dockerfile
 191
 192 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.
 193
 194 ## Contributing
 195
 196 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
 197
 198 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
 199
 200
 201 ## Architecture
 202
 203 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
 204
 205 ### Backend
 206
 207   * The backend is a REST API
 208   * Servers communicate with each others through it
 209     * A network is composed by servers that communicate between them
 210     * Each server of a network has a list of all other servers of this network
 211     * 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
 212     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
 213     * 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
 214     * Each server has a RSA key to encrypt and sign communications with other servers
 215   * A server is a tracker responsible for all the videos uploaded in it
 216   * 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
 217   * A network can live and evolve by expelling bad pod (with too many downtimes for example)
 218
 219 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
 220
 221 Here are some simple schemes:
 222
 223 <p align="center">
 224
 225 <img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
 226
 227 <img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
 228
 229 <img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
 230
 231 <img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
 232
 233 <img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks"
 234
 235 </p>
 236
 237 ### Frontend
 238
 239 There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
 240 The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.