README.md

   1 <h1 align="center">
   2   PeerTube
   3 </h1>
   4
   5 <h4 align="center">
   6 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=dev">
  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=develop" 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=dev">
  37     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
  38   </a>
  39
  40   <a href="http://standardjs.com/">
  41     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
  42   </a>
  43
  44   <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
  45     <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
  46   </a>
  47 </p>
  48
  49 <br />
  50
  51 <p align="center">
  52   <a href="http://peertube.cpy.re">
  53     <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
  54   </a>
  55 </p>
  56
  57 ## Demonstration
  58
  59 Want to see in action?
  60
  61    * 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)
  62    * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
  63    * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly.
  64
  65 ## Why
  66
  67 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.
  68
  69 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
  70 But it's not enought because one video could become famous and overload the server.
  71 It's the reason why we need to use a P2P protocol to limit the server load.
  72 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
  73
  74 ## Features
  75
  76 - [X] Frontend
  77   - [X] Angular frontend
  78 - [X] Join a network
  79   - [X] Generate a RSA key
  80   - [X] Ask for the friend list of other pods and make friend with them
  81   - [X] Get the list of the videos owned by a pod when making friend with it
  82   - [X] Post the list of its own videos when making friend with another pod
  83 - [X] Quit a network
  84 - [X] Upload a video
  85   - [X] Seed the video
  86   - [X] Send the meta data to all other friends
  87 - [X] Remove the video
  88 - [X] List the videos
  89 - [X] Search a video name (local index)
  90 - [X] View the video in an HTML5 page with WebTorrent
  91 - [X] Manage admin account
  92   - [X] Connection
  93   - [X] Account rights (upload...)
  94 - [X] Make the network auto sufficient (eject bad pods etc)
  95 - [X] Validate the prototype (test PeerTube in a real world)
  96 - [ ] Manage API breaks
  97 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
  98 - [X] Admin panel
  99   - [X] Stats
 100   - [X] Friends list
 101   - [X] Manage users (create/remove)
 102 - [X] OpenGraph tags
 103 - [ ] User playlists
 104 - [ ] User subscriptions (by tags, author...)
 105 - [X] Signaling a video to the admin origin pod
 106 - [X] Videos view count
 107 - [X] Videos likes/dislikes
 108 - [ ] Videos comments?
 109
 110 ## Installation
 111
 112 ### Front compatibility
 113
 114   * Chromium
 115   * Firefox (>= 42 for MediaSource support)
 116
 117 ### Dependencies
 118
 119   * **NodeJS >= 4.x**
 120   * **npm >= 3.x**
 121   * OpenSSL (cli)
 122   * PostgreSQL
 123   * FFmpeg
 124
 125 #### Debian
 126
 127   * Install NodeJS 4.x (actual LTS): [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)
 128   * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
 129   * Run:
 130
 131         # apt-get update
 132         # apt-get install ffmpeg postgresql-9.4 openssl
 133         # npm install -g npm@3
 134
 135 #### Other distribution... (PR welcome)
 136
 137
 138 ### Sources
 139
 140     $ git clone -b master https://github.com/Chocobozzz/PeerTube
 141     $ cd PeerTube
 142     $ npm install # Or npm install --unsafe-perm for root user
 143     $ npm run build
 144
 145 ## Usage
 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. Keys set in this file will override those of `config/default.yml`.
 154
 155 Finally, run the server with the `production` `NODE_ENV` variable set.
 156
 157     $ NODE_ENV=production npm start
 158
 159 The administrator password is automatically generated and can be found in the logs. You can set another password with:
 160
 161     $ NODE_ENV=production npm run reset-password -- -u root
 162
 163 **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
 164
 165 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
 166
 167 You can check the application (CORS headers, tracker websocket...) by running:
 168
 169     $ NODE_ENV=production npm run check
 170
 171 See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
 172
 173 ### Upgrade
 174
 175 The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
 176
 177     # systemctl stop peertube
 178     $ npm run upgrade
 179     # systemctl start peertube
 180
 181 ### Development
 182
 183 In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them:
 184
 185     $ npm run dev
 186
 187 **Username**: *root* <br/>
 188 **Password**: *test*
 189
 190 ### Test with 3 fresh nodes
 191
 192     $ npm run clean:server:test
 193     $ npm run play
 194
 195 Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. 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 :)
 196
 197 ### Other commands
 198
 199 To print all available command run:
 200
 201     $ npm run help
 202
 203 ## Dockerfile
 204
 205 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.
 206
 207 ## Contributing
 208
 209 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
 210
 211 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
 212
 213 See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
 214
 215
 216 ## Architecture
 217
 218 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
 219
 220 ### Backend
 221
 222   * The backend is a REST API
 223   * Servers communicate with each others through it
 224     * A network is composed by servers that communicate between them
 225     * Each server of a network has a list of all other servers of this network
 226     * 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
 227     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
 228     * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
 229     * Each server has a RSA key to encrypt and sign communications with other servers
 230   * A server is a tracker responsible for all the videos uploaded in it
 231   * Even if nobody watches a video, it is seeded by the server (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded
 232   * A network can live and evolve by expelling bad pod (with too many downtimes for example)
 233
 234 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
 235
 236 Here are some simple schemes:
 237
 238 <p align="center">
 239
 240 <img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
 241
 242 <img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
 243
 244 <img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
 245
 246 <img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
 247
 248 <img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
 249
 250 </p>
 251
 252 ### Frontend
 253
 254 There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
 255 The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.