-# PeTube
+# PeerTube
-Prototype of a decentralized video streaming platform using P2P (bittorent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
+*Server*
+
+[](https://travis-ci.org/Chocobozzz/PeerTube)
+[](https://david-dm.org/Chocobozzz/PeerTube)
+[](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
+[](https://codeclimate.com/github/Chocobozzz/PeerTube)
+
+*Client*
+
+[](https://david-dm.org/Chocobozzz/PeerTube?path=client)
+[](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
+
+Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent).
[](https://github.com/feross/standard)
+## 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.
+
## Features
-- [ ] Join a network
+- [X] Frontend
+ - [X] ~~Simple frontend (All elements are generated by jQuery)~~
+ - [X] Angular 2 frontend
+- [X] Join a network
- [X] Generate a RSA key
- [X] Ask for the friend list of other pods and make friend with them
- - [ ] Get the list of the videos owned by a pod when making friend with it
- - [ ] Post the list of its own videos when making friend with another pod
+ - [X] Get the list of the videos owned by a pod when making friend with it
+ - [X] Post the list of its own videos when making friend with another pod
+- [X] Quit a network
- [X] Upload a video
- [X] Seed the video
- [X] Send the meta data to all other friends
- [X] View the video in an HTML5 page with webtorrent
- [ ] Manage user accounts
- [ ] Inscription
- - [ ] Connection
- - [ ] Account rights (upload...)
-- [ ] Make the network auto sufficient (eject bad pods etc)
+ - [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)
-## Front compatibility
- * Chromium
- * Firefox (>= 42 for MediaSource support)
+## Installation
+### Front compatibility
-## Usage
+ * Chromium
+ * Firefox (>= 42 for MediaSource support)
### Dependencies
- * NodeJS >= 0.12
- * Grunt-cli (npm install -g grunt-cli)
+ * **NodeJS >= 4.2**
* OpenSSL (cli)
* MongoDB
- * xvfb-run (for electron)
+ * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
-### Test It!
+#### Debian
- $ git clone https://github.com/Chocobozzz/PeerTube
- $ cd PeopleTube
+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)
+
+ # 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)
+
+
+### Sources
+
+ $ git clone https://github.com/Chocobozzz/PeerTube
+ $ cd PeerTube
$ npm install
+ $ npm run build
+
+## Usage
+
+### Run the server
+
$ npm start
### Test with 3 fresh nodes
- $ scripts/clean_test.sh
- $ scripts/run_servers.sh
-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 :)
+ $ npm run clean:server:test
+ $ npm run play
-## Why
+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 :)
-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.
+### 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.
## Architecture
+See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+
### Backend
* The backend whould be a REST API
Here are some simple schemes:
-
+
-
+
-
+
-
+
-
+
### Frontend
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...).
-The backend uses bittorent protocol, so users could use their favorite bittorent client to download/play the video after having its torrent URI.
+The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.
projects / github / Chocobozzz / PeerTube.git / blobdiff