README.md

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