# PeerTube
+**Server**
[![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube)
[![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube)
[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
[![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube)
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
+**Client**
+[![Dependency Status](https://david-dm.org/Chocobozzz/PeerTube.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client)
+[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client)](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
+Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
+
+![screenshot](https://lutim.cpy.re/vC2loRww)
+
+## Demonstration
+
+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.
+
## Why
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.
So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
But it's not enought because one video could become famous and overload the server.
It's the reason why we need to use a P2P protocol to limit the server load.
-Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
+Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
## Features
-- [ ] Frontend
+- [X] Frontend
- [X] ~~Simple frontend (All elements are generated by jQuery)~~
- [X] Angular 2 frontend
- [X] Join a network
- [X] Remove the video
- [X] List the videos
- [X] Search a video name (local index)
-- [X] View the video in an HTML5 page with webtorrent
+- [X] View the video in an HTML5 page with WebTorrent
- [ ] Manage user accounts
- [ ] Inscription
- - [ ] Connection
- - [ ] Account rights (upload...)
+ - [X] Connection
+ - [X] Account rights (upload...)
- [X] Make the network auto sufficient (eject bad pods etc)
- [ ] Manage API breaks
- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
-## Usage
+## Installation
### Front compatibility
* **NodeJS >= 4.2**
* OpenSSL (cli)
* MongoDB
- * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
+ * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
#### Debian
-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)
+ * 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)
+ * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
+ * Run:
+
+ # apt-get update
+ # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
+ # npm install -g electron-prebuilt
- # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
- # npm install -g electron-prebuilt
+#### Other distribution... (PR welcome)
-### Test It!
+### Sources
$ git clone https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
- # npm install -g electron-prebuilt
$ npm install
$ npm run build
+
+## Usage
+
+### Run the server
+
$ npm start
### Test with 3 fresh nodes
- $ bin/clean_test.sh
- $ bin/run_servers.sh
+ $ npm run clean:server:test
+ $ npm run play
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 :)
-### Dockerfile
+### Other commands
+
+To print all available command run:
+
+ $ npm run help
+
+## Dockerfile
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.
Here are some simple schemes:
-![Decentralized](http://lutim.cpy.re/aV2pawRz)
+![Decentralized](https://lutim.cpy.re/Q7mnNdJP)
-![Watch a video](http://lutim.cpy.re/AlOeoVPi)
+![Watch a video](https://lutim.cpy.re/0riSzAp1)
-![Watch a video P2P](http://lutim.cpy.re/fb0JH6C3)
+![Watch a video P2P](https://lutim.cpy.re/OzMSOtxG)
-![Join a network](http://lutim.cpy.re/ijuCgmpI)
+![Join a network](https://lutim.cpy.re/uVjNNRa9)
-![Many networks](http://lutim.cpy.re/iz8mXHug)
+![Many networks](https://lutim.cpy.re/udTMqcb0)
### Frontend