</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>.
+Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
+directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
</h4>
+**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit
+that promotes, spreads and develops free culture in general, and free-libre
+software in particular. If you want to support this project, please [consider
+donating them](https://soutenir.framasoft.org/en/).**
+
<p align="center">
<strong>Client</strong>
<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/mRdBAdeD.png" alt="screenshot" />
</a>
</p>
## Demonstration
-Want to see in action?
+Want to see it 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
- * 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.
+ * [Demo server](http://peertube.cpy.re)
+ * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
+ 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
-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.
+We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
+Vimeo... with a centralized software. One organization alone may not have
+enough money to pay for bandwidth and video storage of its servers.
-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.
+So we need to have a decentralized network of servers seeding videos (as
+[Diaspora](https://github.com/diaspora/diaspora) for example). But it's not
+enough 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, as of today.
## Features
- [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
- - [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] Angular frontend
+- [X] Join the fediverse
+ - [X] Follow other instances
+ - [X] Unfollow an instance
+ - [X] Get for the followers/following list
- [X] Upload a video
- [X] Seed the video
- - [X] Send the meta data to all other friends
+ - [X] Send the meta data with ActivityPub to followers
- [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] 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)
+- [X] View the video in an HTML5 player with WebTorrent
- [X] Admin panel
- - [X] Stats
- - [X] Friends list
- - [X] Manage users (create/remove)
-- [ ] User playlists
+- [X] OpenGraph tags
+- [X] OEmbed
+- [X] Update video
+- [X] Videos view counter
+- [X] Videos likes/dislikes
+- [X] Transcoding to different definitions
+- [X] Download file/torrent
+- [X] User video bytes quota
+- [X] User video channels
+- [X] NSFW warnings/settings
+- [X] Video description in markdown
+- [X] User roles (administrator, moderator)
+- [X] User registration
+- [X] Video privacy settings (public, unlisted or private)
+- [X] Signaling a video to the admin origin PeerTube instance
+- [ ] Videos comments
+- [ ] User playlist
- [ ] User subscriptions (by tags, author...)
+- [ ] Add "DDOS" security
## Installation
+See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete
+installation commands.
+
### Front compatibility
* Chromium
### Dependencies
- * **NodeJS >= 4.2**
- * **npm >= 3.0**
+ * **NodeJS >= 8.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.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)
- * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
- * Run:
+ 1. Install NodeJS 8.x (current 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)
+ 2. Install yarn:
+ [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
+ 4. Run:
- # apt-get update
- # apt-get install ffmpeg mongodb
- # npm install -g npm@3
+```bash
+ $ apt-get update
+ $ apt-get install ffmpeg postgresql openssl
+```
-#### Other distribution... (PR welcome)
+#### Ubuntu 16.04
+ 1. Install NodeJS 8.x (current LTS): (same as Debian)
+ 2. Install yarn: (same as Debian)
+ 3. Run:
-### Sources
+```bash
+ $ apt-get update
+ $ apt-get install ffmpeg postgresql openssl
+```
- $ git clone https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ npm install
- $ npm run build
+#### Arch Linux
-## Usage
+ 1. Run:
-### Development
+```bash
+ $ pacman -S nodejs yarn ffmpeg postgresql openssl
+```
- $ npm run dev
+#### Other distributions
-### Test with 3 fresh nodes
+Feel free to update this README file in a pull request!
- $ npm run clean:server:test
- $ npm run play
+### Build from the sources
+
+```bash
+ $ git clone -b master https://github.com/Chocobozzz/PeerTube
+ $ cd PeerTube
+ $ yarn install
+ $ npm run build
+```
-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 :)
+## Usage
### Production
-If you want to run PeerTube for production (bad idea for now :) ):
+If you want to run PeerTube in production (which might be a bad idea for now :) ):
+```bash
$ cp config/production.yaml.example config/production.yaml
+```
-Then edit the `config/production.yaml` file according to your webserver configuration.
+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.
+Finally, run the server with the `NODE_ENV` environment variable set to
+`production`:
+```bash
$ 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:
+```bash
+ $ 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
-### Other commands
+You can check the application (CORS headers, tracker websocket...) by running:
-To print all available command run:
+```bash
+ $ NODE_ENV=production npm run check
+```
- $ npm run help
+### Upgrade
-## Dockerfile
+The following commands will upgrade the source (according to your current
+branch), upgrade node modules and rebuild client application:
-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.
+```bash
+ # systemctl stop peertube
+ $ npm run upgrade-peertube
+ # systemctl start peertube
+```
-## Contributing
+### Test with three fresh nodes
+
+```bash
+ $ npm run clean:server:test
+ $ npm run play
+```
+
+Then you will get 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.
+
+### Other commands
-See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+To print all available commands, run:
-See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+```bash
+ $ npm run help
+```
+
+## Contributing
+See the [contributing
+guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md)
+to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
+coder to help!
## Architecture
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explanation.
### Backend
- * 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...)
- * 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 (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)
-
-See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
+ * The backend is a REST API.
+ * Servers communicate with each others with [Activity
+ Pub](https://www.w3.org/TR/activitypub/).
+ * Each server has its own users who query it (search videos, query where the
+ torrent URI of this specific video is...).
+ * If a user uploads a video, the server seeds it and sends its followers some
+ metadata (name, short description, torrent URI...).
+ * 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 (through
+ [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the
+ video was uploaded.
Here are some simple schemes:
<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/MyeS4q1g" alt="Join a network" />
-
-<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks"
+<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
</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.
projects / github / Chocobozzz / PeerTube.git / blobdiff