1
0
Fork 0
ActivityPub-federated video streaming platform using P2P directly in your web browser https://github.com/Chocobozzz/PeerTube
Go to file
Haelwenn (lanodan) Monnier 396f224b5c support/doc/dependencies.md: Add Gentoo documentation
Related to: https://github.com/Chocobozzz/PeerTube/issues/778
2018-07-11 14:16:31 +02:00
.github Add translation guide 2018-06-21 14:07:53 +02:00
client Update P2P & Privacy paragraph 2018-07-11 14:00:26 +02:00
config Add warning regarding transcoding 2018-06-07 16:44:22 +02:00
scripts Migrate to bull 2018-07-11 14:00:17 +02:00
server Migrate to bull 2018-07-11 14:00:17 +02:00
shared Migrate to bull 2018-07-11 14:00:17 +02:00
support support/doc/dependencies.md: Add Gentoo documentation 2018-07-11 14:16:31 +02:00
.codeclimate.yml Fetch outbox to grab old activities 2017-11-27 19:40:53 +01:00
.dockerignore Improve dockerfile 2018-04-16 18:44:57 +02:00
.editorconfig add .editorconfig to maintain consistent coding styles (#429) 2018-03-29 11:07:51 +02:00
.gitignore Update iso639 translations for french and deutch 2018-06-19 14:02:57 +02:00
.prettierignore added linter and prettifier via commit hooks 2018-05-13 16:54:34 +02:00
.prettierrc.yml Upgrade to rxjs 6 2018-05-16 09:42:54 +02:00
.sass-lint.yml Blue links color in comments 2018-06-18 10:46:47 +02:00
.travis.yml Test travis retry 2018-06-21 14:34:59 +02:00
ARCHITECTURE.md Try to improve documentations/readme 2018-01-12 18:07:41 +01:00
CHANGELOG.md Fix changelog syntax related to AP url warning 2018-06-25 19:19:06 +02:00
CODE_OF_CONDUCT.md Add `etc` on some points of the CoC (#305) 2018-02-20 14:40:54 +01:00
CREDITS.md Update contributors list 2018-07-11 10:20:03 +02:00
FAQ.md (doc/faq) add precision regarding code forge 2018-07-06 09:30:01 +02:00
LICENSE Change licence to AGPL 2017-02-24 18:26:09 +01:00
README.md Add link to server admin tools in readme 2018-07-11 10:49:50 +02:00
package.json Switch to bull 2018-07-11 14:00:17 +02:00
server.ts Do not enable cors twice on /api in test mode 2018-06-29 09:48:19 +02:00
tsconfig.json feature: initial syndication feeds tests for instance-wide feeds 2018-04-26 16:30:27 +02:00
tslint.json Fix lint momory issues 2018-03-08 17:31:11 +01:00
yarn.lock Switch to bull 2018-07-11 14:00:17 +02:00
zanata.xml Update translations from zanata and add cs and eo 2018-07-09 15:04:17 +02:00

README.md

PeerTube

Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent.

We have run a crowdfunding campaign to pave the road to version 1.0 of PeerTube. Thanks to everyone who pitched in and shared the news around. You can now check out the corresponding milestone and help its development!

Client
Dependency Status devDependency Status

Server
Build Status Dependencies Status devDependency Status JavaScript Style Guide


screenshot

Getting Started

Demonstration

Want to see it in action?

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 for example). But it's not enough because one video could become famous and overload the server. That is why we need to use a P2P protocol to limit the server load. Thanks to 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 in production

See the production guide.

Run on YunoHost

Install Peertube with YunoHost

Peertube app for YunoHost. See here.

Run using Docker

See the docker guide.

Contribute/Translate/Test

See the contributing guide to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a coder to help!

API REST documentation

Quick Start: /support/doc/api/quickstart.md

Endpoints documentation:

Tools

FAQ

If you have a question, please try to find the answer in the FAQ first.

Architecture

See ARCHITECTURE.md for a more detailed explanation.

Backend

  • The backend is a REST API.
  • Servers communicate with each others with Activity Pub.
  • 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 on it.
  • Even if nobody watches a video, it is seeded by the server (through WebSeed protocol) where the video was uploaded.

Here are some simple schemes:

Decentralized Watch a video Watch a P2P video

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.

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.

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/.