Reword docs (#176)

* Reword documentation;

* Wrap lines at 80 characters in the documentation.

* Wrap CONTRIBUTING.md too;

* Tweaks to CONTRIBUTING.md wording;

* Move development section to CONTRIBUTING.md;

* Explain database creation in CONTRIBUTING.md;
This commit is contained in:
Benjamin Bouvier
2018-01-06 18:10:30 +01:00
committed by Chocobozzz
parent 99eff32c00
commit e755a63a1b
4 changed files with 196 additions and 88 deletions

23
FAQ.md
View File

@@ -2,25 +2,31 @@
## If nobody watches a video, is it seeded?
Yes, the origin server always seeds videos uploaded on it through [Webseed](http://www.bittorrent.org/beps/bep_0019.html).
Yes, the origin server always seeds videos uploaded on it thanks to
[Webseed](http://www.bittorrent.org/beps/bep_0019.html).
## What is WebSeed?
It is a BitTorrent extension that allow a server to seed a file through HTTP. It just need to serve statically a file, and then the clients will request chunks with a Content-Range HTTP header.
It is a BitTorrent extension that allows a server to seed a file through HTTP.
It just needs to statically serve a file, then the clients will request chunks
with a `Content-Range` HTTP header.
## If a client requests each chunk of a video through HTTP, the server be overloaded!
## If a client requests each chunk of a video through HTTP, will the server be overloaded?
Not really. Reverse proxies like Nginx handle very well requests of static files. In my tests it can send chunks at 10MB/s without consuming more than 5% of CPU on a very small VPS.
Not really. Reverse proxies like Nginx handle very well requests of static
files. In my tests, it can send chunks at 10MB/s without consuming more than 5%
of CPU on a very small VPS.
## An index of all videos of servers you follow won't be too large for small servers?
## Will an index of all the videos of servers you follow be too large for small servers?
No, 1000000 videos will represent around 2GB on PostgreSQL. It is acceptable for a video platform.
In our benchmarks, 1,000,000 videos takes around 2GB of storage on PostgreSQL.
We think it is acceptable for a video platform.
## What kind of videos can I upload?
## What codecs can I use for the videos I want to upload?
WEBM, MP4 or OGV videos.
@@ -29,4 +35,5 @@ WEBM, MP4 or OGV videos.
If you already have followers, you can't.
If you don't: update your configuration and run `NODE_ENV=production npm run update-host` to update the torrent files.
If you don't have any followers, update your configuration and run
`NODE_ENV=production npm run update-host` to update the torrent files.