</h1>
<h4 align="center">
-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 to 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=dev">
+ <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>
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
+ <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>
<p align="center">
<a href="https://peertube.cpy.re">
- <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
+ <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>
+
## Demonstration
-Want to see in action?
+Want to see it in action?
- * [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.
+ * 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)
## 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.
-
-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] 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] 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
-- [X] Manage admin account
- - [X] Connection
- - [X] Account rights (upload...)
-- [X] Make the network auto sufficient (eject bad pods etc)
-- [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...)
-- [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
- * Firefox (>= 42 for MediaSource support)
-
-### Dependencies
-
- * **NodeJS >= 6.x**
- * **npm >= 3.x**
- * yarn
- * OpenSSL (cli)
- * PostgreSQL
- * FFmpeg
-
-#### Debian
-
- * 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
-
-#### Other distribution... (PR welcome)
-
-
-### Sources
-
- $ git clone -b master https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ 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`.
+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.
-Finally, run the server with the `production` `NODE_ENV` variable set.
+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.
- $ NODE_ENV=production npm start
+## Dependencies
-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
-
-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:
-
- $ npm run dev
-
-**Username**: *root* <br/>
-**Password**: *test*
+ * nginx
+ * PostgreSQL
+ * Redis
+ * **NodeJS >= 8.x**
+ * yarn
+ * OpenSSL (cli)
+ * **FFmpeg >= 3.x**
-### Test with 3 fresh nodes
+## Run using Docker
- $ npm run clean:server:test
- $ npm run play
+See the [docker guide](/support/doc/docker.md)
-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
-### Other commands
+See the [production guide](/support/doc/production.md).
-To print all available command run:
+## Contributing/Test
- $ npm run help
+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!
-## Dockerfile
+## API REST documentation
-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.
+For now only on Github:
-## Contributing
+ * 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)
-See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+## Tools
-See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+ * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
-See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
+## FAQ
+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 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/NvRAcv6U.png" alt="Watch a video" />
-<img src="https://lutim.cpy.re/VLheltQk" alt="Watch a video" />
+<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
-<img src="https://lutim.cpy.re/worHQwKv" alt="Watch a P2P video" />
+</p>
-<img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
+## License
-<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
+Copyright (C) 2018 PeerTube Contributors
-</p>
+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 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.
+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