-# PeerTube
+<h1 align="center">
+ PeerTube
+</h1>
-**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)
+<h4 align="center">
+Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
+</h4>
-**Client**
-[](https://david-dm.org/Chocobozzz/PeerTube?path=client)
-[](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
+<p align="center">
+ <strong>Client</strong>
-[](https://github.com/feross/standard)
+ <br />
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
+ <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
+ </a>
-
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies">
+ <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
+ </a>
+</p>
+
+<p align="center">
+ <strong>Server</strong>
+
+ <br />
+
+ <a href="https://travis-ci.org/Chocobozzz/PeerTube">
+ <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master" alt="Build Status" />
+ </a>
+
+ <a href="https://david-dm.org/Chocobozzz/PeerTube">
+ <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
+ </a>
+
+ <a href="https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies">
+ <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
+ </a>
+
+ <a href="https://codeclimate.com/github/Chocobozzz/PeerTube">
+ <img src="https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg" alt="Code climate" />
+ </a>
+
+ <a href="http://standardjs.com/">
+ <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
+ </a>
+</p>
+
+<br />
+
+<p align="center">
+ <a href="http://peertube.cpy.re">
+ <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
+ </a>
+</p>
## Demonstration
- [X] List the videos
- [X] Search a video name (local index)
- [X] View the video in an HTML5 page with WebTorrent
-- [ ] Manage user accounts
- - [ ] Inscription
+- [X] Manage admin account
- [X] Connection
- [X] Account rights (upload...)
- [X] Make the network auto sufficient (eject bad pods etc)
+- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
- [ ] Manage API breaks
- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
+- [ ] Admin panel
+ - [ ] Stats about the network (how many friends, how many requests per hour...)
+ - [ ] Stats about videos
+ - [ ] Manage users (create/remove)
## Installation
### Development
- $ npm start
+ $ npm run dev
### Test with 3 fresh nodes
$ 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 :)
+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 :)
### Production
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.
+## Contributing
+
+See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+
+See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+
+
## 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
- * Servers would communicate with each others with it
- * Each server of a network has a list of all other servers of the network
- * 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"
+ * The backend is a REST API
+ * Servers communicate with each others through it
+ * A network is composed by servers that communicate between them
+ * Each server of a network has a list of all other servers of this network
+ * 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
* Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
- * 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
+ * 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
* Each server has a RSA key to encrypt and sign communications with other servers
* A server is a tracker responsible for all the videos uploaded in it
* Even if nobody watches a video, it is seeded by the server where the video was uploaded
- * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
* A network can live and evolve by expelling bad pod (with too many downtimes for example)
+ * A server **would** run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
Here are some simple schemes:
-
+<p align="center">
+
+<img src="https://lutim.cpy.re/Q7mnNdJP" alt="Decentralized" />
+
+<img src="https://lutim.cpy.re/0riSzAp1" alt="Watch a video" />
-
+<img src="https://lutim.cpy.re/OzMSOtxG" alt="Watch a P2P video" />
-
+<img src="https://lutim.cpy.re/uVjNNRa9" alt="Join a network" />
-
+<img src="https://lutim.cpy.re/udTMqcb0" alt="Many networks"
-
+</p>
### 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 bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.
+There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
+The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video with its torrent URI.
projects / github / Chocobozzz / PeerTube.git / blobdiff