README.md

   1 # PeerTube
   2
   3 [![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
   4 [![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
   5 [![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
   6
   7 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
   8
   9 [![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
  10
  11 ## Why
  12
  13 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.
  14
  15 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
  16 But it's not enought because one video could become famous and overload the server.
  17 It's the reason why we need to use a P2P protocol to limit the server load.
  18 Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
  19
  20 ## Features
  21
  22 - [ ] Frontend
  23   - [X] Simple frontend (All elements are generated by jQuery)
  24   - [ ] AngularJS frontend
  25 - [X] Join a network
  26   - [X] Generate a RSA key
  27   - [X] Ask for the friend list of other pods and make friend with them
  28   - [X] Get the list of the videos owned by a pod when making friend with it
  29   - [X] Post the list of its own videos when making friend with another pod
  30 - [X] Quit a network
  31 - [X] Upload a video
  32   - [X] Seed the video
  33   - [X] Send the meta data to all other friends
  34 - [X] Remove the video
  35 - [X] List the videos
  36 - [X] Search a video name (local index)
  37 - [X] View the video in an HTML5 page with webtorrent
  38 - [ ]  Manage user accounts
  39   - [ ] Inscription
  40   - [ ] Connection
  41   - [ ] Account rights (upload...)
  42 - [X] Make the network auto sufficient (eject bad pods etc)
  43 - [ ] Manage API breaks
  44 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
  45
  46
  47 ## Usage
  48
  49 ### Front compatibility
  50
  51   * Chromium
  52   * Firefox (>= 42 for MediaSource support)
  53
  54 ### Dependencies
  55
  56   * **NodeJS >= 4.2**
  57   * Grunt-cli (npm install -g grunt-cli)
  58   * OpenSSL (cli)
  59   * MongoDB
  60   * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron)
  61
  62 ### Test It!
  63
  64     $ git clone https://github.com/Chocobozzz/PeerTube
  65     $ cd PeerTube
  66     # npm install -g electron-prebuilt
  67     $ npm install
  68     $ npm start
  69
  70 ### Test with 3 fresh nodes
  71
  72     $ scripts/clean_test.sh
  73     $ scripts/run_servers.sh
  74
  75 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 :)
  76
  77 ### Dockerfile
  78
  79 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.
  80
  81 ## Architecture
  82
  83 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
  84
  85 ### Backend
  86
  87   * The backend whould be a REST API
  88   * Servers would communicate with each others with it
  89     * Each server of a network has a list of all other servers of the network
  90     * When a new installed server wants to join a network, it just has to get the list of the servers via one server and tell them "Hi I'm new in the network, communicate with me too please"
  91     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
  92     * Server begins to seed and sends to the other servers of the network the video information (name, short description, torrent URI) of a new uploaded video
  93     * Each server has a RSA key to encrypt and sign communications with other servers
  94   * A server is a tracker responsible for all the videos uploaded in it
  95   * Even if nobody watches a video, it is seeded by the server where the video was uploaded
  96   * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
  97   * A network can live and evolve by expelling bad pod (with too many downtimes for example)
  98
  99 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
 100
 101 Here are some simple schemes:
 102
 103 ![Decentralized](http://lutim.cpy.re/aV2pawRz)
 104
 105 ![Watch a video](http://lutim.cpy.re/AlOeoVPi)
 106
 107 ![Watch a video P2P](http://lutim.cpy.re/fb0JH6C3)
 108
 109 ![Join a network](http://lutim.cpy.re/ijuCgmpI)
 110
 111 ![Many networks](http://lutim.cpy.re/iz8mXHug)
 112
 113 ### Frontend
 114
 115 There would be a simple frontend (Bootstrap, AngularJS) but since the backend is a REST API anybody could build a frontend (Web application, desktop application...).
 116 The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.