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://instances.joinpeertube.org">Join an instance</a></strong>
  10   | <strong><a href="#package-create-your-own-instance">Create an instance</a></strong>
  11   | <strong><a href="#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/VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a">
  35     <img src="https://automate.browserstack.com/badge.svg?badge_key=VHUxYy9zYnZqWnkxTTcyNEpPRVdzY2VzN1VhY3hBQUIrYTk2NGFtMnMvTT0tLWxuMk1vVnBzeDJ4cFpFY1JEK2xjSUE9PQ==--cf445693d1fc03efd86a3a5030d079a0de3ece7a"/>
  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 But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers,
  71 all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse
  72 (federated video network) by talking our implementation of ActivityPub.
  73 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>.
  74
  75 To learn more, see:
  76 * 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
  77 * PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
  78 * Demonstration instances:
  79   * [peertube.cpy.re](https://peertube.cpy.re)
  80   * [peertube2.cpy.re](https://peertube2.cpy.re)
  81   * [peertube3.cpy.re](https://peertube3.cpy.re)
  82 * 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)
  83
  84 :sparkles: Features
  85 ----------------------------------------------------------------
  86
  87 <img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
  88 <h3 align="left">Video streaming, even in live!</h3>
  89 <p align="left">
  90 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!
  91 </p>
  92 <p align="left">
  93 You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!
  94 </p>
  95
  96 ---
  97
  98 <img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>
  99
 100 <h3 align="right">Keep in touch with video creators</h3>
 101 <p align="right">
 102 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.
 103 </p>
 104
 105 ---
 106
 107 <img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>
 108
 109 <h3 align="left">An interface to call home</h3>
 110 <p align="left">
 111 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™.
 112 </p>
 113
 114 ---
 115
 116 <h3 align="right">Communities that help each other</h3>
 117 <p align="right">
 118 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>).
 119 </p>
 120 <p align="right">
 121 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>).
 122 </p>
 123
 124 :raised_hands: Contributing
 125 ----------------------------------------------------------------
 126
 127 You don't need to be a programmer to help!
 128
 129 You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
 130 guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
 131
 132 You can also join the cheerful bunch that makes our community:
 133
 134 * Chat<a name="contact"></a>:
 135   * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
 136   * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
 137 * Forum:
 138   * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
 139
 140 Feel free to reach out if you have any questions or ideas! :speech_balloon:
 141
 142 :package: Create your own instance
 143 ----------------------------------------------------------------
 144
 145 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.
 146
 147 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)).
 148
 149 :book: Documentation
 150 ----------------------------------------------------------------
 151
 152 If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first.
 153
 154 ### User documentation
 155
 156 See the [user documentation](https://docs.joinpeertube.org/use-setup-account).
 157
 158 ### Admin documentation
 159
 160 See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
 161
 162 See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances).
 163
 164 ### Tools documentation
 165
 166 Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools).
 167
 168 ### Technical documentation
 169
 170 See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices.
 171
 172 See our REST API documentation:
 173   * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
 174   * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
 175
 176 See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub).
 177
 178 ## License
 179
 180 Copyright (C) 2015-2021 PeerTube Contributors (see [CREDITS.md](CREDITS.md))
 181
 182 This program is free software: you can redistribute it and/or modify
 183 it under the terms of the GNU Affero General Public License as published
 184 by the Free Software Foundation, either version 3 of the License, or
 185 (at your option) any later version.
 186
 187 This program is distributed in the hope that it will be useful,
 188 but WITHOUT ANY WARRANTY; without even the implied warranty of
 189 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 190 GNU Affero General Public License for more details.
 191
 192 You should have received a copy of the GNU Affero General Public License
 193 along with this program.  If not, see <https://www.gnu.org/licenses/>.