</h1>
<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>.
+
Decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
</h4>
<p align="center">
<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">
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
</a>
</p>
<br />
<a href="https://travis-ci.org/Chocobozzz/PeerTube">
- <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master" alt="Build Status" />
+ <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" 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">
+ <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
<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 href="http://standardjs.com/">
+ <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
</a>
- <br />
-
- <a href="https://github.com/feross/standard">
- <img src="https://cdn.rawgit.com/feross/standard/master/badge.svg" alt="js-standard-style" />
+ <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
+ <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
</a>
</p>
-
+<br />
+
+<p align="center">
+ <a href="https://peertube.cpy.re">
+ <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
+ </a>
+</p>
## Demonstration
Want to see in action?
- * 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)
- * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
+ * [Demo server](http://peertube.cpy.re)
+ * [Video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
+ * 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.
## Why
## Features
- [X] Frontend
- - [X] ~~Simple frontend (All elements are generated by jQuery)~~
- - [X] Angular 2 frontend
+ - [X] Angular frontend
- [X] Join a network
- [X] Generate a RSA key
- [X] Ask for the friend list of other pods and make friend with them
- [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
+- [X] Validate the prototype (test PeerTube in a real world)
+- [ ] Manage inter pod 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)
+- [X] Admin panel
+ - [X] Stats
+ - [X] Friends list
+ - [X] Manage users (create/remove)
+- [X] OpenGraph tags
+- [X] Update video
+- [X] Videos view count
+- [X] Videos likes/dislikes
+- [ ] Videos comments?
+- [X] User registration
+- [ ] User playlists
+- [ ] User subscriptions (by tags, author...)
+- [X] Signaling a video to the admin origin pod
## Installation
+See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
+
### Front compatibility
* Chromium
### Dependencies
- * **NodeJS >= 4.2**
+ * **NodeJS >= 6.x**
+ * **npm >= 3.x**
+ * yarn
* OpenSSL (cli)
- * MongoDB
- * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
+ * PostgreSQL
+ * FFmpeg
#### 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 6.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)
+ * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
* 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 ffmpeg postgresql-9.4 openssl
#### Other distribution... (PR welcome)
### Sources
- $ git clone https://github.com/Chocobozzz/PeerTube
+ $ git clone -b master https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
- $ npm install
+ $ yarn install
$ npm run build
## Usage
+### Production
+
+If you want to run PeerTube for production (bad idea for now :) ):
+
+ $ cp config/production.yaml.example config/production.yaml
+
+Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
+
+Finally, run the server with the `production` `NODE_ENV` variable set.
+
+ $ NODE_ENV=production npm start
+
+The administrator password is automatically generated and can be found in the logs. You can set another password with:
+
+ $ NODE_ENV=production npm run reset-password -- -u root
+
+**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
+**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
+
+You can check the application (CORS headers, tracker websocket...) by running:
+
+ $ NODE_ENV=production npm run check
+
+### Upgrade
+
+The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
+
+ # systemctl stop peertube
+ $ npm run upgrade
+ # systemctl start peertube
+
### Development
- $ npm start
+In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds.
-### Test with 3 fresh nodes
+To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too):
- $ npm run clean:server:test
- $ npm run play
+ $ npm run dev:server
-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 :)
+The server (with the client) will listen on `localhost:9000`.
-### Production
-If you want to run PeerTube for production (bad idea for now :) ):
+To develop on the client side (client files are automatically compiled when we modify them):
- $ cp config/production.yaml.example config/production.yaml
+ $ npm run dev:client
-Then edit the `config/production.yaml` file according to your webserver configuration.
+The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser).
-Finally, run the server with the `production` `NODE_ENV` variable set.
+**Username**: *root* <br/>
+**Password**: *test*
- $ NODE_ENV=production npm start
+### 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}` 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 :)
### Other commands
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).
+
+See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
+
+
## Architecture
See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
* 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...)
- * If an user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
+ * 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
+ * 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
* 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 :)
<p align="center">
-<img src="https://lutim.cpy.re/Q7mnNdJP" alt="Decentralized" />
+<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
-<img src="https://lutim.cpy.re/0riSzAp1" alt="Watch a video" />
+<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
-<img src="https://lutim.cpy.re/OzMSOtxG" alt="Watch a P2P video" />
+<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
-<img src="https://lutim.cpy.re/uVjNNRa9" alt="Join a network" />
+<img src="https://lutim.cpy.re/wWVuczBz.png" alt="Join a network" />
-<img src="https://lutim.cpy.re/udTMqcb0" alt="Many networks"
+<img src="https://lutim.cpy.re/AMo3uP0D.png" alt="Many networks" />
</p>
### Frontend
-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.
+There already is a frontend (Angular) 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