PeerTube README

The project's README from github.com/Chocobozzz/PeerTube. As one markdown file: 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

GitHub Test Status BrowserStack Status Weblate Status

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. :clapper:

To learn more:

:sparkles: 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).

:raised_hands: 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. :wink:

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

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

:package: 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).

:book: 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-2025 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/.

PeerTube (Chocobozzz/PeerTube)

Searching Database…

15.4K ·GitHub
这是什么?PeerTube 是一个免费、去中心化且联邦化的视频平台,是 YouTube、Dailymotion、Vimeo 等中心化服务的替代品。
这是我要安装的一个应用,还是一个由独立服务器组成的网络?这是一套服务器软件,你可以将其作为自己的“实例”运行;各实例之间通过 ActivityPub 互联,因此视频和关注功能可以在整个网络中通用,而不只局限于一个网站。
我该如何创建自己的 PeerTube 实例?请按照生产部署指南操作,这是安装或升级 PeerTube 的推荐方式;社区提供的安装包还支持 YunoHost 和 Docker 等平台。
运行实例需要服务器端满足哪些条件?代码基于 Node.js 22+ 和 pnpm 10.9+ 构建,并内置了 S3 存储、OAuth2、OpenTelemetry 等相关依赖。
运行实例是否需要很大的服务器?硬件需求取决于实例的规模;常见问题(FAQ)中有专门一节介绍此事,说明小型实例完全可行,但大型实例需要更多资源。
这是为谁准备的——观众还是实例管理员?两者都适用:观众只需在联邦宇宙(Fediverse)中跨实例观看、关注创作者,甚至可以通过 Mastodon 或 RSS 实现;管理员则负责运行并定制自己的实例。
P2P 实际上如何减轻实例的负载?观众的浏览器之间通过 WebRTC 相互分享视频片段,友好实例还可以互相缓存对方的视频,因此小型实例也能借助这种方式把内容分发给更多受众。
观众不在某个实例上注册账号,能否关注该频道?可以。你可以通过联邦宇宙(Mastodon、Pleroma 等)或直接通过 RSS 关注视频创作者,无需在托管视频的实例上拥有账号。
PeerTube 是否支持直播,而不仅仅是上传视频?支持。你可以通过自己的直播客户端开始直播,实例同时支持一次性直播活动和长期直播频道。
观众如何在经济上支持创作者?创作者可以添加一个“支持”按钮,显示一段消息,并链接到其捐赠账户或其他支持方式,无需依赖广告或按次付费观看。
Creator
Chocobozzz
Size
592.5 MB
Stars
15.4K
Age
10y
Commits · 90 Days