peertube_ynh/README.md

PeerTube for YunoHost

Lire ce readme en français.

This package allows you to install PeerTube quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser, using WebTorrent.

Shipped version: 4.0.0~ynh1

Demo: http://peertube.cpy.re

Screenshots

Disclaimers / important information

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, Friendica YunoHost,Mastodon YunoHost), Diaspora (Diaspora YunoHost),Funkwhale (Funkwhale YunoHost). 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, 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.

• Any known limitations, constrains or stuff not working, such as (but not limited to):

  • Require dedicated domain like peertube.domain.tld.

  • Admin username is: root.

  • Admin password and LDAP configuration will be sent to the email address given at the time of the installation.

  • URL can not be changed once selected. Choose the domain wisely.

  • You need more then 1 GB 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

  • This app is multi-instance (you can have more then one PeerTube instance running on a YunoHost server)

  • If you are hosted on OVH virtual machine or experiencing gyp ERR! configure error, please switch to ovh_fix

  • LDAP auth is supported, LDAP configuration will be sent to the email address given at the time of the installation.

  • HTTP auth is not supported

Documentation and resources

• Official app website: https://joinpeertube.org/fr/
• Official admin documentation: https://docs.joinpeertube.org/
• Upstream app code repository: https://github.com/Chocobozzz/PeerTube/
• YunoHost documentation for this app: https://yunohost.org/app_peertube
• Report a bug: https://github.com/YunoHost-Apps/peertube_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/testing --debug
or
sudo yunohost app upgrade peertube -u https://github.com/YunoHost-Apps/peertube_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps