<h1 align="center">
- PeerTube
+ <a href="https://joinpeertube.org">
+ <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube">
+ </a>
</h1>
+<p align=center>
+ <strong><a href="https://joinpeertube.org">Website</a></strong>
+ | <strong><a href="https://instances.joinpeertube.org">Join an instance</a></strong>
+ | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong>
+ | <strong><a href="#contact">Chat with us</a></strong>
+ | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
+</p>
+
+<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">
-Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
-directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
+ <strong>Developed with ❤ by <a href="https://framasoft.org">Framasoft</a></strong>
</p>
<p align="center">
-<strong>We are running <a href="https://www.kisskissbankbank.com/en/projects/peertube-a-free-and-federated-video-platform">a crowdfunding campaign</a> to pave the road to version 1.0 of PeerTube!</strong>
+ <a href="https://framasoft.org">
+ <img width="150px" src="https://lutim.cpy.re/FeRgHH8r.png" alt="Framasoft logo"/>
+ </a>
</p>
<p align="center">
<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/VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a">
+ <img src="https://automate.browserstack.com/badge.svg?badge_key=VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a"/>
</a>
- <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>
-
- <a href="https://www.browserstack.com/automate/public-build/VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%">
- <img src='https://www.browserstack.com/automate/badge.svg?badge_key=VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%'/>
+ <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>
-
- <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 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="http://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/mRdBAdeD.png" alt="screenshot" />
+ <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3">
+ <img src="http://lutim.cpy.re/9CLXh0Ys.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>
+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:
-## Demonstration
+But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers,
+all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse
+(federated video network) by talking our implementation of ActivityPub.
+Video load is reduced thanks to P2P in the web browser using <a href="https://github.com/webtorrent/webtorrent">WebTorrent</a> or <a href="https://github.com/novage/p2p-media-loader">p2p-media-loader</a>.
-Want to see it in action?
+To learn more, see:
+* 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)
+ * [peertube2.cpy.re](https://peertube2.cpy.re)
+ * [peertube3.cpy.re](https://peertube3.cpy.re)
+* 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)
- * 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)
+:sparkles: Features
+----------------------------------------------------------------
-## Why
+<img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
+<h3 align="left">Video streaming</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>
-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](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.
+<img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>
-## Dependencies
+<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
- * PostgreSQL
- * Redis
- * **NodeJS >= 8.x**
- * yarn
- * OpenSSL (cli)
- * **FFmpeg >= 3.x**
+---
-## Run using Docker
+<img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>
-See the [docker guide](/support/doc/docker.md)
+<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>
-## Run on YunoHost
-[](https://install-app.yunohost.org/?app=peertube)
+---
-Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh)
+<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?id=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 <strike>incentivize</strike> alter creativity (more about that in our <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>).
+</p>
-## Production
+:raised_hands: Contributing
+----------------------------------------------------------------
-See the [production guide](/support/doc/production.md).
+You don't need to be a coder to help!
-## Contributing/Test
+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:
-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!
+You can also join the cheerful bunch that makes our community:
-## API REST documentation
+* Chat<a name="contact"></a>:
+ * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
+ * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
+* Forum:
+ * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
-Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md)
+Feel free to reach out if you have any questions or ideas! :speech_balloon:
-Endpoints documentation:
+:package: Create your own instance
+----------------------------------------------------------------
- * 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 [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://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) in the FAQ.
-## Tools
+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)).
- * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
- * [Upload videos from the CLI](/support/doc/tools.md)
+:book: Documentation
+----------------------------------------------------------------
-## FAQ
+If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first.
-If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
+### User documentation
-## Architecture
+See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account).
-See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
+### Admin documentation
-### Backend
+See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
- * 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.
+See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances).
-Here are some simple schemes:
+### Tools documentation
-<p align="center">
+Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/#/maintain-tools).
-<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
+### Technical documentation
-<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
+See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices.
-<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
+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)
-</p>
+See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub).
## License
-Copyright (C) 2018 PeerTube Contributors
+Copyright (C) 2015-2020 PeerTube Contributors (see [CREDITS.md](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
projects / github / Chocobozzz / PeerTube.git / blobdiff