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   <br />
  45
  46   <a href="https://github.com/feross/standard">
  47     <img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" alt="js-standard-style" />
  48   </a>
  49 </p>
  50
  51 ![screenshot](https://lutim.cpy.re/vC2loRww)
  52
  53 ## Demonstration
  54
  55 Want to see in action?
  56
  57    * 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)
  58    * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
  59
  60 ## Why
  61
  62 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.
  63
  64 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
  65 But it's not enought because one video could become famous and overload the server.
  66 It's the reason why we need to use a P2P protocol to limit the server load.
  67 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
  68
  69 ## Features
  70
  71 - [X] Frontend
  72   - [X] ~~Simple frontend (All elements are generated by jQuery)~~
  73   - [X] Angular 2 frontend
  74 - [X] Join a network
  75   - [X] Generate a RSA key
  76   - [X] Ask for the friend list of other pods and make friend with them
  77   - [X] Get the list of the videos owned by a pod when making friend with it
  78   - [X] Post the list of its own videos when making friend with another pod
  79 - [X] Quit a network
  80 - [X] Upload a video
  81   - [X] Seed the video
  82   - [X] Send the meta data to all other friends
  83 - [X] Remove the video
  84 - [X] List the videos
  85 - [X] Search a video name (local index)
  86 - [X] View the video in an HTML5 page with WebTorrent
  87 - [X] Manage admin account
  88   - [X] Connection
  89   - [X] Account rights (upload...)
  90 - [X] Make the network auto sufficient (eject bad pods etc)
  91 - [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
  92 - [ ] Manage API breaks
  93 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
  94 - [ ] Admin panel
  95   - [ ] Stats about the network (how many friends, how many requests per hour...)
  96   - [ ] Stats about videos
  97   - [ ] Manage users (create/remove)
  98
  99
 100 ## Installation
 101
 102 ### Front compatibility
 103
 104   * Chromium
 105   * Firefox (>= 42 for MediaSource support)
 106
 107 ### Dependencies
 108
 109   * **NodeJS >= 4.2**
 110   * OpenSSL (cli)
 111   * MongoDB
 112   * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
 113
 114 #### Debian
 115
 116   * Install NodeJS 4.2: [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)
 117   * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
 118   * Run:
 119
 120         # apt-get update
 121         # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
 122         # npm install -g electron-prebuilt
 123
 124 #### Other distribution... (PR welcome)
 125
 126
 127 ### Sources
 128
 129     $ git clone https://github.com/Chocobozzz/PeerTube
 130     $ cd PeerTube
 131     $ npm install
 132     $ npm run build
 133
 134 ## Usage
 135
 136 ### Development
 137
 138     $ npm start
 139
 140 ### Test with 3 fresh nodes
 141
 142     $ npm run clean:server:test
 143     $ npm run play
 144
 145 Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. 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 :)
 146
 147 ### Production
 148
 149 If you want to run PeerTube for production (bad idea for now :) ):
 150
 151     $ cp config/production.yaml.example config/production.yaml
 152
 153 Then edit the `config/production.yaml` file according to your webserver configuration.
 154
 155 Finally, run the server with the `production` `NODE_ENV` variable set.
 156
 157     $ NODE_ENV=production npm start
 158
 159 ### Other commands
 160
 161 To print all available command run:
 162
 163     $ npm run help
 164
 165 ## Dockerfile
 166
 167 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.
 168
 169 ## Architecture
 170
 171 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
 172
 173 ### Backend
 174
 175   * The backend is a REST API
 176   * Servers communicate with each others through it
 177     * A network is composed by servers that communicate between them
 178     * Each server of a network has a list of all other servers of this network
 179     * 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
 180     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
 181     * If an user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
 182     * Each server has a RSA key to encrypt and sign communications with other servers
 183   * A server is a tracker responsible for all the videos uploaded in it
 184   * Even if nobody watches a video, it is seeded by the server where the video was uploaded
 185   * A network can live and evolve by expelling bad pod (with too many downtimes for example)
 186   * A server **would** run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
 187
 188 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
 189
 190 Here are some simple schemes:
 191
 192 <p align="center">
 193
 194 <img src="https://lutim.cpy.re/Q7mnNdJP" alt="Decentralized" />
 195
 196 <img src="https://lutim.cpy.re/0riSzAp1" alt="Watch a video" />
 197
 198 <img src="https://lutim.cpy.re/OzMSOtxG" alt="Watch a P2P video" />
 199
 200 <img src="https://lutim.cpy.re/uVjNNRa9" alt="Join a network" />
 201
 202 <img src="https://lutim.cpy.re/udTMqcb0" alt="Many networks"
 203
 204 </p>
 205
 206 ### Frontend
 207
 208 There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
 209 The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video with its torrent URI.