-# PeerTube
+<h1 align="center">
+ PeerTube
+</h1>
-*Server*
+<h4 align="center">
+Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
+directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
+</h4>
-[](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)
+**PeerTube is developed by [Framasoft](https://framasoft.org/?l=en), a non-profit
+that promotes and spreads free culture in general, and free-libre software in
+particular. If you want to support this project, please [consider
+donating to them](https://soutenir.framasoft.org/en/).**
-*Client*
+<p align="center">
+ <strong>Client</strong>
-[](https://david-dm.org/Chocobozzz/PeerTube?path=client)
-[](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
+ <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>
-[](https://github.com/feross/standard)
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev">
+ <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
+ </a>
+</p>
-## Why
+<p align="center">
+ <strong>Server</strong>
-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
-
-- [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] Upload a video
- - [X] Seed the video
- - [X] Send the meta data to all other friends
-- [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
-- [ ] Manage user accounts
- - [ ] Inscription
- - [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)
-
-
-## Installation
-
-### Front compatibility
-
- * Chromium
- * Firefox (>= 42 for MediaSource support)
-
-### Dependencies
-
- * **NodeJS >= 4.2**
- * OpenSSL (cli)
- * MongoDB
- * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
+ <br />
+
+ <a href="https://travis-ci.org/Chocobozzz/PeerTube">
+ <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?type=dev">
+ <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
+ </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="https://peertube.cpy.re">
+ <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" />
+ </a>
+</p>
+
+<p align="center">
+ <strong><a title="Website" target="_blank" href="https://joinpeertube.org">Website</a> |
+ <a title="Instances list" target="_blank" href="https://instances.joinpeertube.org">Instances list</a>
+ </strong>
+</p>
-#### Debian
+## Demonstration
-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)
+Want to see it in action?
- # 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
+ * Demonstration servers:
+ * [peertube.cpy.re](http://peertube.cpy.re)
+ * [peertube2.cpy.re](http://peertube2.cpy.re)
+ * [peertube3.cpy.re](http://peertube3.cpy.re)
+ * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
+ to see what the "decentralization feature" looks like
+ * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see
+ the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
-#### Other distribution... (PR welcome)
+## Why
+
+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 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.
+
+## Dependencies
+
+ * nginx
+ * PostgreSQL
+ * Redis
+ * **NodeJS >= 8.x**
+ * yarn
+ * OpenSSL (cli)
+ * **FFmpeg >= 3.x**
+## Run using Docker
-### Sources
+See the [docker guide](/support/doc/docker.md)
- $ git clone https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ npm install
- $ npm run build
+## Production
-## Usage
+See the [production guide](/support/doc/production.md).
-### Run the server
+## Contributing/Test
- $ npm start
+See the [contributing
+guide](/.github/CONTRIBUTING.md)
+to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a
+coder to help!
-### Test with 3 fresh nodes
+## API REST documentation
- $ npm run clean:server:test
- $ npm run play
+Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md)
-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 :)
+Endpoints documentation:
-### Other commands
+ * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html)
+ * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
-To print all available command run:
+## Tools
- $ npm run help
+ * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
-## Dockerfile
+## FAQ
-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.
+If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
## Architecture
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
### 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"
- * 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
- * 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)
-
-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/6Qut3ure.png" alt="Decentralized" />
+
+<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
+
+<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
-
+</p>
-
+## License
-
+Copyright (C) 2018 PeerTube Contributors
-
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
-### Frontend
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
-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.
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
projects / oweals / peertube.git / blobdiff