<h1 align="center">
- PeerTube
+ <a href="https://joinpeertube.org">
+ <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube">
+ </a>
</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>.
-</h4>
+<p align=center>
+ <strong><a href="https://joinpeertube.org">Website</a></strong>
+ | <strong><a href="https://joinpeertube.org/instances">Join an instance</a></strong>
+ | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance">Create an instance</a></strong>
+ | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#contact">Chat with us</a></strong>
+ | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
+</p>
-**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit that promotes, spreads and develops free-libre software. If you want to support this project, please [consider donating them](https://soutenir.framasoft.org/en/).**
+<p align="center">
+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.
+</p>
+
+<p align="center">
+ <strong>Developed with ❤ by <a href="https://framasoft.org">Framasoft</a></strong>
+</p>
+
+<p align="center">
+ <a href="https://framasoft.org">
+ <img width="150px" src="https://lutim.cpy.re/FeRgHH8r.png" alt="Framasoft logo"/>
+ </a>
+</p>
<p align="center">
<strong>Client</strong>
<br />
- <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 href="https://automate.browserstack.com/public-build/ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536">
+ <img src="https://automate.browserstack.com/badge.svg?badge_key=ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536"/>
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
- <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
+ <a href="https://weblate.framasoft.org/projects/peertube/angular/">
+ <img src="https://weblate.framasoft.org/widgets/peertube/-/angular/svg-badge.svg"/>
</a>
</p>
<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 href="https://github.com/Chocobozzz/PeerTube/actions?query=workflow%3A%22Test+Suite%22+branch%3Adevelop">
+ <img alt="test suite status" src="https://github.com/Chocobozzz/PeerTube/workflows/Test%20Suite/badge.svg" />
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
- <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
- </a>
-
- <a href="http://standardjs.com/">
+ <a href="https://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/9HOUfGK8" alt="screenshot" />
+ <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3">
+ <img src="https://lutim.cpy.re/9CLXh0Ys.png" alt="screenshot" />
</a>
</p>
-## Demonstration
-
-Want to see in action?
-
- * [Demo server](http://peertube.cpy.re)
- * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) 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.
-
-## Why
-
-We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth 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 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 right now.
-
-## Features
-
-- [X] Frontend
- - [X] Angular frontend
-- [X] Join the fediverse
- - [X] Follow other instances
- - [X] Unfollow an instance
- - [X] Get for the followers/following list
-- [X] Upload a video
- - [X] Seed the video
- - [X] Send the meta data with ActivityPub to followers
-- [X] Remove the video
-- [X] List the videos
-- [X] View the video in an HTML5 player with WebTorrent
-- [X] Admin panel
-- [X] OpenGraph tags
-- [X] OEmbed
-- [X] Update video
-- [X] Videos view counter
-- [X] Videos likes/dislikes
-- [X] Transcoding to different definitions
-- [X] Download file/torrent
-- [X] User video bytes quota
-- [X] User video channels
-- [X] NSFW warnings/settings
-- [X] Video description in markdown
-- [X] User roles (administrator, moderator)
-- [X] User registration
-- [X] Video privacy settings (public, unlisted or private)
-- [X] Signaling a video to the admin origin PeerTube instance
-- [ ] Videos comments
-- [ ] User playlist
-- [ ] User subscriptions (by tags, author...)
-- [ ] Add "DDOS" security
-
-
-## Installation
+Introduction
+----------------------------------------------------------------
-See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
+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:
-### Front compatibility
+To learn more:
+* This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works
+* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
+* Demonstration instances:
+ * [peertube.cpy.re](https://peertube.cpy.re) (stable)
+ * [peertube2.cpy.re](https://peertube2.cpy.re) (Nightly)
+ * [peertube3.cpy.re](https://peertube3.cpy.re) (RC)
+* This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative)
- * Chromium
- * Firefox (>= 42 for MediaSource support)
+:sparkles: Features
+----------------------------------------------------------------
-### Dependencies
-
- * **NodeJS >= 6.x**
- * **npm >= 3.x**
- * yarn
- * OpenSSL (cli)
- * PostgreSQL
- * FFmpeg
-
-#### Debian
-
- 1. Install NodeJS 6.x (previous 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)
- 2. Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
- 3. Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
- 4. Run:
-
- $ apt-get update
- $ apt-get install ffmpeg postgresql-9.4 openssl
-
-#### Ubuntu 16.04
-
- 1. Install NodeJS 8.x (current LTS): (same as Debian)
- 2. Install yarn: (same as Debian)
- 3. Run:
-
- $ apt-get update
- $ apt-get install ffmpeg postgresql 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`.
+<p align=center>
+ <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-viewers">All features for viewers</a></strong>
+ | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-content-creators">All features for content creators</a></strong>
+ | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-administrators">All features for administrators</a></strong>
+</p>
-Finally, run the server with the `production` `NODE_ENV` variable set.
+<img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
+<h3 align="left">Video streaming, even in live!</h3>
+<p align="left">
+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!
+</p>
+<p align="left">
+You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!
+</p>
- $ NODE_ENV=production npm start
+---
-The administrator password is automatically generated and can be found in the logs. You can set another password with:
+<img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>
- $ NODE_ENV=production npm run reset-password -- -u root
+<h3 align="right">Keep in touch with video creators</h3>
+<p align="right">
+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.
+</p>
-**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:
+<img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>
- $ NODE_ENV=production npm run check
+<h3 align="left">An interface to call home</h3>
+<p align="left">
+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™.
+</p>
-### Upgrade
+---
-The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
+<h3 align="right">Communities that help each other</h3>
+<p align="right">
+In addition to visitors using WebTorrent 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 <a href="https://docs.joinpeertube.org/contribute/architecture#redundancy-between-instances">redundancy guide</a>).
+</p>
+<p align="right">
+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 <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>).
+</p>
- # systemctl stop peertube
- $ npm run upgrade-peertube
- # systemctl start peertube
-### Development
-In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds.
+:raised_hands: Contributing
+----------------------------------------------------------------
-To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too):
+You don't need to be a programmer to help!
- $ npm run dev:server
+You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
+guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
-The server (with the client) will listen on `localhost:9000`.
+You can also join the cheerful bunch that makes our community:
+* Chat<a name="contact"></a>:
+ * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
+ * IRC : **[#peertube on irc.libera.chat:6697](https://web.libera.chat/#peertube)**
+* Forum:
+ * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
-To develop on the client side (client files are automatically compiled when we modify them):
+Feel free to reach out if you have any questions or ideas! :speech_balloon:
- $ npm run dev:client
+:package: Create your own instance
+----------------------------------------------------------------
-The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser).
+See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://joinpeertube.org/faq#should-i-have-a-big-server-to-run-peertube) in the FAQ.
-**Username**: *root* <br/>
-**Password**: *test*
+See the [community packages](https://docs.joinpeertube.org/install/unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)).
-### Test with 3 fresh nodes
+:book: Documentation
+----------------------------------------------------------------
- $ npm run clean:server:test
- $ npm run play
+If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first.
-Then you will get 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.
+### User documentation
-### Other commands
+See the [user documentation](https://docs.joinpeertube.org/use/setup-account).
-To print all available command run:
+### Admin documentation
- $ npm run help
+See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
-## Contributing
+See the more general [admin documentation](https://docs.joinpeertube.org/admin/following-instances).
-See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
+### Tools documentation
-See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain/tools).
-See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
+### Technical documentation
+See the [architecture blueprint](https://docs.joinpeertube.org/contribute/architecture) for a more detailed explanation of the architectural choices.
-## Architecture
+See our REST API documentation:
+ * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
+ * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub).
-### Backend
+## License
- * 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, where the torrent URI of this specific video is...)
- * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers
- * 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
+### Logo
-Here are some simple schemes:
+[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), by [Framasoft](https://framasoft.org)
-<p align="center">
+### Code
-<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
+Copyright (C) 2015-2023 PeerTube Contributors (see [CREDITS.md](/CREDITS.md))
-<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
+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.
-<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
+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.
-</p>
+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/>.
projects / github / Chocobozzz / PeerTube.git / blobdiff