README.md

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