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