allow limiting video-comments rss feeds to an account or video channel
[oweals/peertube.git] / FAQ.md
diff --git a/FAQ.md b/FAQ.md
index 1bcd6006a90e5af580546d88228c0566ddb554cf..7930af35e8136af9e289a4521555d3244ae9d37d 100644 (file)
--- a/FAQ.md
+++ b/FAQ.md
@@ -1,9 +1,65 @@
 # FAQ
 
+<!-- Table of contents generated with DocToc: https://github.com/thlorenz/doctoc -->
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Why did you create PeerTube?](#why-did-you-create-peertube)
+- [I don't like the name "PeerTube"](#i-dont-like-the-name-peertube)
+- [If nobody watches a video, is it seeded?](#if-nobody-watches-a-video-is-it-seeded)
+- [What is WebSeed?](#what-is-webseed)
+- [If a client requests each chunk of a video through HTTP, will the server be overloaded?](#if-a-client-requests-each-chunk-of-a-video-through-http-will-the-server-be-overloaded)
+- [Will an index of all the videos of servers you follow be too large for small servers?](#will-an-index-of-all-the-videos-of-servers-you-follow-be-too-large-for-small-servers)
+- [Which container formats can I use for the videos I want to upload?](#which-container-formats-can-i-use-for-the-videos-i-want-to-upload)
+- [I want to change my domain name, how can I do that?](#i-want-to-change-my-domain-name-how-can-i-do-that)
+- [Why do we have to put our Twitter username in PeerTube configuration?](#why-do-we-have-to-put-our-twitter-username-in-peertube-configuration)
+- [How video views are calculated?](#how-video-views-are-calculated)
+- [Should I have a big server to run PeerTube?](#should-i-have-a-big-server-to-run-peertube)
+- [Can I seed videos with my classic BitTorrent client (Transmission, rTorrent...)?](#can-i-seed-videos-with-my-classic-bittorrent-client-transmission-rtorrent)
+- [Why host on GitHub and Framagit?](#why-host-on-github-and-framagit)
+- [Are you going to use the Steem blockchain?](#are-you-going-to-use-the-steem-blockchain)
+- [Are you going to support advertisements?](#are-you-going-to-support-advertisements)
+- [What is "creation dynamic" and why not modify it?](#what-is-creation-dynamic-and-why-not-modify-it)
+- [I have found a security vulnerability in PeerTube. Where and how should I report it?](#i-have-found-a-security-vulnerability-in-peertube-where-and-how-should-i-report-it)
+- [Does PeerTube ensures federation compatibility with previous version?](#does-peertube-ensures-federation-compatibility-with-previous-version)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Why did you create PeerTube?
+
+We can't build a FOSS video streaming alternative to YouTube, Dailymotion,
+Vimeo... with centralized software. One organization alone may not have
+enough money to pay for bandwidth and video storage of its servers.
+
+Our stance is that only a decentralized network of servers can provide an
+acceptable answer to technical issues (bandwidth, transcoding expenses, etc.)
+and social answers (need for a particular moderation policy, preserving
+content, etc.).
+
+While a paragraph is not enough to answer all these problems, PeerTube has
+very early prouded itself for using a contributory design, both for creating
+communities as federated nodes (as [Mastodon](https://joinmastodon.org/) for
+example), and for seeding videos (instances can seed each other's videos). But it's not
+enough because one video could become popular and overload the server. That is
+why we need to use a P2P protocol to limit the server load. Thanks to
+[WebTorrent](https://github.com/feross/webtorrent), we can use BitTorrent
+inside most modern web browsers, and users become seeds as the video gets
+more viewers.
+
+
+## I don't like the name "PeerTube"
+
+PeerTube is just the name of the software. You can install it on your
+server, and choose a name you want. For example, [this instance](https://framatube.org/)
+is named "Framatube".
+
+
 ## If nobody watches a video, is it seeded?
 
 Yes, the origin server always seeds videos uploaded on it thanks to
 [Webseed](http://www.bittorrent.org/beps/bep_0019.html).
+It can also be helped by other servers using [redundancy](https://docs.joinpeertube.org/#/contribute-architecture?id=redundancy-between-instances).
 
 
 ## What is WebSeed?
@@ -26,14 +82,91 @@ In our benchmarks, 1,000,000 videos takes around 2GB of storage on PostgreSQL.
 We think it is acceptable for a video platform.
 
 
-## What codecs can I use for the videos I want to upload?
+## Which container formats can I use for the videos I want to upload?
+
+WEBM, MP4 or OGV videos are supported by default (they are streamable formats),
+but instance administrators can additionally enable support for MKV, MOV, AVI
+and FLV formats when transcoding is enabled on their instance.
+
+
+## I want to change my domain name, how can I do that?
+
+It's not officially supported, but you can try the `update-host` script: https://docs.joinpeertube.org/#/maintain-tools?id=update-hostjs
+
+
+## Why do we have to put our Twitter username in PeerTube configuration?
+
+You don't have to: we set a default value if you don't have a Twitter account.
+We need this information because Twitter requires an account for links share/videos embed on their platform.
+
+
+## How video views are calculated?
+
+Your web browser sends a view to the server after 30 seconds of playback. If a video is less than 30 seconds in length, a view is sent after 75% of the video. After giving a view, that IP address cannot add another view in the next hour.
+Views are buffered, so don't panic if the view counter stays the same after you watched a video.
+
+
+## Should I have a big server to run PeerTube?
+
+Not really. For instance, the demonstration server [https://peertube.cpy.re](https://peertube.cpy.re) has 2 vCore and 2GB of RAM and consumes on average:
+ * **CPU** -> nginx ~ 20%, peertube ~ 10%,   postgres ~ 1%, redis ~ 3%
+ * **RAM** -> nginx ~ 6MB, peertube ~ 120MB, postgres ~ 10MB, redis ~ 5MB
+
+So you would need:
+ * **CPU** 1 core if you don't enable transcoding, 2 at least if you enable it (works with 1 but this is really slow)
+ * **RAM** 1GB
+ * **Storage** Completely depends on how many videos your users will upload
+
+
+## Can I seed videos with my classic BitTorrent client (Transmission, rTorrent...)?
+
+Yes you can, but you won't be able to send data to users that watch the video in their web browser.
+The reason is they connect to peers through WebRTC whereas your BitTorrent client uses classic TCP/UDP.
+To check if your BitTorrent client supports WebTorrent you can see this issue: https://github.com/webtorrent/webtorrent/issues/369
+
+
+## Why host on GitHub and Framagit?
+
+The project has initially been hosted on GitHub by Chocobozzz. A full migration to [Framagit](https://framagit.org/framasoft/peertube/PeerTube) would be ideal now that Framasoft supports PeerTube, but it would take a lot of time and is an ongoing effort.
+
+
+## Are you going to use the Steem blockchain?
+
+Short answer: no, since like most appchains/votechains, it modifies the dynamic of creation, and as such cannot be integrated into mainline PeerTube. Read more about that in [the dedicated section](#what-is-creation-dynamic-and-why-not-modify-it).
+
+Long answer is that the Steem blockchain goes astray of its promises of fairness and decentralization: the deliberate relaunching of the currency to ensure centralization, and the stake-based voting power, makes manipulation by wealthy users inevitable ([source here](https://decentralize.today/the-ugly-truth-behind-steemit-1a525f5e156)).
+Worse, money generated primarily goes to stakeholders ([source here](https://steemit.com/steemit/@orly/how-the-steem-pyramid-scheme-really-works) ).
+For more information, read the complete whitepaper analysis done by [Tone Vays](https://twitter.com/ToneVays/status/761975587451928576).
+
+## Are you going to support advertisements?
+
+Short answer: no, we don't want advertisers to dictate which content should be financed.
+That would modify the dynamic of creation; as such it cannot be integrated into mainline PeerTube.
+Read more about that in [the dedicated section](#what-is-creation-dynamic-and-why-not-modify-it).
+
+The long answer is probably more subtle. YouTube has shaped generations of video creators by making it easy to place ads;
+but making big money with the platform can be a challenge.
+A typical video ad runs between $.10 and $.30 per 1000 views (as of March 2018).
+More than 70% of video creators use ads as the main way to make money on YouTube, yet less than 3% of video creators make a living out of their YouTube activity (with partnerships and commissions, otherwise counting only ad revenue it drops to 1%).
+Read more about it in the 2018 study by Mathias Bärtl, [*YouTube channels, uploads and views: A statistical analysis of the past 10 years*](https://www.dropbox.com/s/0cq4wtxm83s95t2/10.1177%401354856517736979.pdf?dl=0).
+To the best of our knowledge, small and medium-community creators are better off getting support from their community on platforms such as Liberapay, Tipeee or Patreon.
+Moreover, don't forget that advertisers already pay considering YouTube's large user base; with PeerTube's way smaller user base and refusal of user profiling, a pay-per-view that's lower than YouTube's could only be expected.
+
+## What is "creation dynamic" and why not modify it?
+
+We define creation dynamic as the way any original content, regardless of its monetary value, is created and incentivized.
+We want to stay neutral by limiting the influence of our platform on authors as much as possible. We are not curators, and want to limit the scope of PeerTube instance owners and administrators' responsibilities to moderation tasks only.
+
+If you still want to use a functionality potentially altering that state of things, then you could interface with our upcoming plug-in system, which will be the place to integrate such features in the near future.
 
-WEBM, MP4 or OGV videos.
+With that being said, know that we are not against these features *per se*.
+We are always open to discussion about potential PRs bringing in features, even of that kind. But we certainly won't dedicate our limited resources to develop them ourselves when there is so much to be done elsewhere.
 
+## I have found a security vulnerability in PeerTube. Where and how should I report it?
 
-## I want to change my host, how can I do that?
+We have a policy for contributions related to security. Please refer to [SECURITY.md](./SECURITY.md)
 
-If you already have followers, you can't.
+## Does PeerTube ensures federation compatibility with previous version?
 
-If you don't have any followers, update your configuration and run
-`NODE_ENV=production npm run update-host` to update the torrent files (they contain your domain name).
+We **try** to keep compatibility with the latest minor version (2.3.1 with 2.2 for example).
+We don't have resources to keep compatibility with other versions.