Go to file
Chocobozzz b4f4432459
Viewers federation protocol v2
More efficient than the current one where instance is not fast enough to
send all viewers if a video becomes popular

The new protocol can be enabled by setting env
USE_VIEWERS_FEDERATION_V2='true'

Introduce a result field in View activity that contains the number of
viewers. This field is used by the origin instance to send the total
viewers on the video to remote instances. The difference with the
current protocol is that we don't have to send viewers individually to
remote instances.

There are 4 cases:
 * View activity from federation on Remote Video -> instance replaces
   all current viewers by a new viewer that contains the result counter
 * View activity from federation on Local Video -> instance adds the
   viewer without considering the result counter
 * Local view on Remote Video -> instance adds the viewer and send it to
   the origin instance
 * Local view on Local Video -> instance adds the viewer

Periodically PeerTube cleanups expired viewers. On local videos, the
instance sends to remote instances a View activity with the result
counter so they can update their viewers counter for that particular
video
2023-12-20 10:55:47 +01:00
.github Update codeql ci 2023-11-08 10:53:32 +01:00
apps Add warning for web_videos directory name 2023-11-29 09:28:12 +01:00
client Fix big play button skin applied to settings menu 2023-12-18 09:36:22 +01:00
config Improve tests 2023-12-20 10:55:28 +01:00
packages Viewers federation protocol v2 2023-12-20 10:55:47 +01:00
scripts Fix build concurrency issue 2023-12-18 09:36:08 +01:00
server Viewers federation protocol v2 2023-12-20 10:55:47 +01:00
support Text corrections 2023-12-06 08:45:06 +01:00
.dockerignore Fix docker build 2019-09-16 10:52:26 +02:00
.editorconfig Update editor config 2023-03-14 14:15:39 +01:00
.eslintrc.json Migrate server to ESM 2023-08-11 15:02:33 +02:00
.gitignore Migrate server to ESM 2023-08-11 15:02:33 +02:00
.gitpod.yml Fix PostreSQL initialization for Gitpod 2020-12-06 13:58:00 +01:00
.mocharc.cjs Migrate server to ESM 2023-08-11 15:02:33 +02:00
CHANGELOG.md Update changelog 2023-12-11 08:56:19 +01:00
CODE_OF_CONDUCT.md Misc wording fixes, while learning how to test/contribute (#5727) 2023-04-05 08:51:38 +02:00
CREDITS.md Update code contributors 2023-07-26 09:49:53 +02:00
FAQ.md Update FAQ.md 2021-08-11 10:46:14 +02:00
LICENSE Change licence to AGPL 2017-02-24 18:26:09 +01:00
README.md Prefer web videos in favour of webtorrent 2023-07-11 09:21:13 +02:00
SECURITY.md Update my email 2020-11-12 16:29:32 +01:00
package.json Bumped to version v6.0.2 2023-12-11 09:09:56 +01:00
tsconfig.base.json Migrate server to ESM 2023-08-11 15:02:33 +02:00
tsconfig.eslint.json Migrate server to ESM 2023-08-11 15:02:33 +02:00
yarn.lock Remove async-lru cache for jsonld 2023-11-29 06:51:29 +01:00

README.md

PeerTube

Website | Join an instance | Create an instance | Chat with us | Donate

Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free.

Developed with ❤ by Framasoft

Framasoft logo

Client

Server
test suite status JavaScript Style Guide


screenshot

Introduction

PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. 🎬

To learn more:

Features

All features for viewers | All features for content creators | All features for administrators

Video streaming, even in live!

Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website!

You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!


Keep in touch with video creators

Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS.


An interface to call home

Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshit™.


Communities that help each other

In addition to visitors using P2P with WebRTC to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our redundancy guide).

Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and alter creativity (more about that in our FAQ).

🙌 Contributing

You don't need to be a programmer to help!

You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the contributing guide to know how, it takes less than 2 minutes to get started. 😉

You can also join the cheerful bunch that makes our community:

Feel free to reach out if you have any questions or ideas! 💬

📦 Create your own instance

See the production guide, which is the recommended way to install or upgrade PeerTube. For hardware requirements, see Should I have a big server to run PeerTube? in the FAQ.

See the community packages, which cover various platforms (including YunoHost and Docker).

📖 Documentation

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

User documentation

See the user documentation.

Admin documentation

See how to create your own instance.

See the more general admin documentation.

Tools documentation

Learn how to import/upload videos from CLI or admin your PeerTube instance with the tools documentation.

Technical documentation

See the architecture blueprint for a more detailed explanation of the architectural choices.

See our REST API documentation:

See our ActivityPub documentation.

License

CC BY-SA 4.0, by Framasoft

Code

Copyright (C) 2015-2023 PeerTube Contributors (see CREDITS.md)

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 https://www.gnu.org/licenses/.