README.md

   1 <h1 align="center">
   2   <a href="https://joinpeertube.org">
   3     <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube">
   4   </a>
   5 </h1>
   6
   7 <p align=center>
   8   <strong><a href="https://joinpeertube.org">Website</a></strong>
   9   | <strong><a href="https://joinpeertube.org/instances">Join an instance</a></strong>
  10   | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance">Create an instance</a></strong>
  11   | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#contact">Chat with us</a></strong>
  12   | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
  13 </p>
  14
  15 <p align="center">
  16 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.
  17 </p>
  18
  19 <p align="center">
  20   <strong>Developed with &#10084; by <a href="https://framasoft.org">Framasoft</a></strong>
  21 </p>
  22
  23 <p align="center">
  24   <a href="https://framasoft.org">
  25     <img width="150px" src="https://lutim.cpy.re/FeRgHH8r.png" alt="Framasoft logo"/>
  26   </a>
  27 </p>
  28
  29 <p align="center">
  30   <strong>Client</strong>
  31
  32   <br />
  33
  34   <a href="https://automate.browserstack.com/public-build/ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536">
  35     <img src="https://automate.browserstack.com/badge.svg?badge_key=ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536"/>
  36   </a>
  37
  38   <a href="https://weblate.framasoft.org/projects/peertube/angular/">
  39     <img src="https://weblate.framasoft.org/widgets/peertube/-/angular/svg-badge.svg"/>
  40   </a>
  41 </p>
  42
  43 <p align="center">
  44   <strong>Server</strong>
  45
  46   <br />
  47
  48   <a href="https://github.com/Chocobozzz/PeerTube/actions?query=workflow%3A%22Test+Suite%22+branch%3Adevelop">
  49     <img alt="test suite status" src="https://github.com/Chocobozzz/PeerTube/workflows/Test%20Suite/badge.svg" />
  50   </a>
  51
  52   <a href="https://standardjs.com/">
  53     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
  54   </a>
  55 </p>
  56
  57 <br />
  58
  59 <p align="center">
  60   <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3">
  61     <img src="https://lutim.cpy.re/9CLXh0Ys.png" alt="screenshot" />
  62   </a>
  63 </p>
  64
  65 Introduction
  66 ----------------------------------------------------------------
  67
  68 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:
  69
  70 To learn more:
  71 * 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
  72 * PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
  73 * Demonstration instances:
  74   * [peertube.cpy.re](https://peertube.cpy.re) (stable)
  75   * [peertube2.cpy.re](https://peertube2.cpy.re) (Nightly)
  76   * [peertube3.cpy.re](https://peertube3.cpy.re) (RC)
  77 * 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)
  78
  79 :sparkles: Features
  80 ----------------------------------------------------------------
  81
  82 <p align=center>
  83   <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-viewers">All features for viewers</a></strong>
  84   | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-content-creators">All features for content creators</a></strong>
  85   | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-administrators">All features for administrators</a></strong>
  86 </p>
  87
  88 <img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
  89 <h3 align="left">Video streaming, even in live!</h3>
  90 <p align="left">
  91 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!
  92 </p>
  93 <p align="left">
  94 You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!
  95 </p>
  96
  97 ---
  98
  99 <img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>
 100
 101 <h3 align="right">Keep in touch with video creators</h3>
 102 <p align="right">
 103 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.
 104 </p>
 105
 106 ---
 107
 108 <img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>
 109
 110 <h3 align="left">An interface to call home</h3>
 111 <p align="left">
 112 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™.
 113 </p>
 114
 115 ---
 116
 117 <h3 align="right">Communities that help each other</h3>
 118 <p align="right">
 119 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>).
 120 </p>
 121 <p align="right">
 122 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>).
 123 </p>
 124
 125
 126
 127 :raised_hands: Contributing
 128 ----------------------------------------------------------------
 129
 130 You don't need to be a programmer to help!
 131
 132 You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
 133 guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
 134
 135 You can also join the cheerful bunch that makes our community:
 136
 137 * Chat<a name="contact"></a>:
 138   * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
 139   * IRC : **[#peertube on irc.libera.chat:6697](https://web.libera.chat/#peertube)**
 140 * Forum:
 141   * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
 142
 143 Feel free to reach out if you have any questions or ideas! :speech_balloon:
 144
 145 :package: Create your own instance
 146 ----------------------------------------------------------------
 147
 148 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.
 149
 150 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)).
 151
 152 :book: Documentation
 153 ----------------------------------------------------------------
 154
 155 If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first.
 156
 157 ### User documentation
 158
 159 See the [user documentation](https://docs.joinpeertube.org/use/setup-account).
 160
 161 ### Admin documentation
 162
 163 See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
 164
 165 See the more general [admin documentation](https://docs.joinpeertube.org/admin/following-instances).
 166
 167 ### Tools documentation
 168
 169 Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain/tools).
 170
 171 ### Technical documentation
 172
 173 See the [architecture blueprint](https://docs.joinpeertube.org/contribute/architecture) for a more detailed explanation of the architectural choices.
 174
 175 See our REST API documentation:
 176   * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
 177   * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
 178
 179 See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub).
 180
 181 ## License
 182
 183 ### Logo
 184
 185 [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), by [Framasoft](https://framasoft.org)
 186
 187 ### Code
 188
 189 Copyright (C) 2015-2023 PeerTube Contributors (see [CREDITS.md](/CREDITS.md))
 190
 191 This program is free software: you can redistribute it and/or modify
 192 it under the terms of the GNU Affero General Public License as published
 193 by the Free Software Foundation, either version 3 of the License, or
 194 (at your option) any later version.
 195
 196 This program is distributed in the hope that it will be useful,
 197 but WITHOUT ANY WARRANTY; without even the implied warranty of
 198 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 199 GNU Affero General Public License for more details.
 200
 201 You should have received a copy of the GNU Affero General Public License
 202 along with this program.  If not, see <https://www.gnu.org/licenses/>.