</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>
-
<a href="http://standardjs.com/">
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
</a>
+
+ <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="http://peertube.cpy.re">
- <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
+ <a href="https://peertube.cpy.re">
+ <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
</a>
</p>
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)
- [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...)
-- [ ] Signaling a video to the admin pod
+- [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.x**
+ * **NodeJS >= 6.x**
* **npm >= 3.x**
+ * yarn
* OpenSSL (cli)
* PostgreSQL
- * ffmpeg
+ * FFmpeg
#### Debian
- * 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)
+ * 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 postgresql-9.4 openssl
- # npm install -g npm@3
#### 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 # Or npm install --unsafe-perm for root user
+ $ yarn install
$ npm run build
## Usage
$ NODE_ENV=production npm start
-**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
+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:
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
+ $ npm run upgrade-peertube
# systemctl start peertube
### Development
-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:
+In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds.
+
+To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too):
+
+ $ npm run dev:server
+
+The server (with the client) will listen on `localhost:9000`.
+
+
+To develop on the client side (client files are automatically compiled when we modify them):
+
+ $ npm run dev:client
+
+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).
- $ npm run dev
+**Username**: *root* <br/>
+**Password**: *test*
### Test with 3 fresh nodes
<p align="center">
-<img src="https://lutim.cpy.re/isWwz8tt" alt="Decentralized" />
+<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
-<img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
+<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
-<img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
+<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
-<img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
+<img src="https://lutim.cpy.re/wWVuczBz.png" alt="Join a network" />
-<img src="https://lutim.cpy.re/PqpTTzdP" 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...).
+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