diff --git a/README.md b/README.md index b2a0f4e..ea7ce25 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,28 @@ Shipped Version: **v1.0.0-beta.9** -

-PeerTube is a decentralized video streaming platform using P2P (BitTorrent) directly in the web browser, using WebTorrent. -

+## What is Peertube ? +PeerTube is a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser, using WebTorrent. +

Peertube is running a crowdfunding campaign to pave the road to version 1.0 of PeerTube! If you liked the app, please donate.

+ ## Why Peertube ? + +We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth and video storage of its server. + +So we need to have a decentralized network of servers seeding videos (as [Hubzilla YunoHost](https://github.com/YunoHost-Apps/hubzilla_ynh), [Friendica YunoHost](https://github.com/YunoHost-Apps/friendica_ynh),[Mastodon YunoHost](https://github.com/YunoHost-Apps/mastodon_ynh)), [Diaspora](https://github.com/diaspora/diaspora) ([Diaspora YunoHost](https://github.com/YunoHost-Apps/diaspora_ynh)),[Funkwhale](https://funkwhale.audio) ([Funkwhale YunoHost](https://github.com/YunoHost-Apps/funkwhale_ynh))). +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. + +## Why is that cool ? +Servers are run independently by different people and organizations. They can apply wildly different moderation policies, so you can find or make one that fits your taste perfectly. + +By watching a video, you help the hosting provider to broadcast it by becoming a broadcaster of the video yourself. Each instance doesn’t need much money to broadcast the videos of its users. + ## Demonstration Want to see in action? @@ -29,13 +43,13 @@ Want to see in action? 1. Require dedicated domain like **peertube.domain.tld**. 1. No LDAP support (blocked until upstream implements it) 1. URL can not be changed once selected. - 1. Take notice that this YunoHost package *claims* the following features: - - [x] Install - - [x] Remove - - [X] Upgrade - - [X] Backup - - [X] Restore - - [X] Multi-instance + 1. You need more then **1GB** of ram. If you don't have it, please create a **swap memory**. + + $ dd if=/dev/zero of=/swapfile bs=1024 count=1048576 + $ mkswap /swapfile + $ swapon /swapfile + $ echo "/swapfile swap swap defaults 0 0" >> /etc/fstab + 1. This app is multi-instance (you can have more then one Peertube instance running on a YunoHost server) ### Install @@ -47,24 +61,10 @@ Want to see in action? 1. **TLS** and **starttls** are disabled for the outgoing mails. If you intent to use email address not hosted on your local server,it's advised to have a proper SMTP configured with tls and starttls settings by editing **/var/www/peertube/config/porduction.yml**. ### Updation - 1. **App can be updated by YunoHost admin interface or by the following command:** + 1. **App can be updated by YunoHost admin interface or with the following command:** $ sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/peertube_ynh peertube - 1. App will backup the **home directory** for Peertube before updating which can take a lot of space on the system. It's advised to check the home folder's free space by - - $ df -h "/home" | awk 'NR==2 { print $4 }' - and compare it with space occupied by the Peertube home directory before updating. - - $ du -hcs /home/yunohost.app/peertube | awk 'NR==2 { print $1 }' - - ## Why -We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth and video storage of its server. - -So we need to have a decentralized network (as [Hubzilla](https://project.hubzilla.org/page/hubzilla/hubzilla-project) ([Hubzilla YunoHost](https://github.com/YunoHost-Apps/hubzilla_ynh)), [Friendica](http://friendi.ca/) ([Friendica YunoHost](https://github.com/YunoHost-Apps/friendica_ynh)), [Mastodon](https://github.com/tootsuite/mastodon) ([Mastodon YunoHost](https://github.com/YunoHost-Apps/mastodon_ynh)), [Diaspora](https://github.com/diaspora/diaspora) ([Diaspora YunoHost](https://github.com/YunoHost-Apps/diaspora_ynh)),[Funkwhale](https://funkwhale.audio) ([Funkwhale YunoHost](https://github.com/YunoHost-Apps/funkwhale_ynh))). -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 right now. ### Dependencies