From e5a3db383e1775bbfec85caba5d06991415272ae Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jun 2019 15:43:45 +0200 Subject: [PATCH 1/4] Create install steps --- README.md | 152 +++++++++++++++++------------------------------------- 1 file changed, 47 insertions(+), 105 deletions(-) diff --git a/README.md b/README.md index 8d3de65..983bb89 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,54 @@ -# PeerTube app for YunoHost +# ovh_fix branch for peertube_ynh -[![Integration level](https://dash.yunohost.org/integration/peertube.svg)](https://dash.yunohost.org/appci/app/peertube) -[![Install PeerTube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=peertube) +If installing on an ovh virtual machine or having `gyp ERR! configure error` please follow the steps indicated in Chocobozzz/PeerTube#830 (comment) -## Overview - -### What is PeerTube ? -PeerTube is a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser, using WebTorrent. - -### 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. - -**Shipped version:** 1.3.1 - -## Screenshots - -![](https://framablog.org/wp-content/uploads/2018/03/Framatube-au-lancement.png) - -## Demo - -Want to see in action? - - * [Here](http://peertube.cpy.re) are the list of instances ran by people around the world. Be a part of it. - -## Installation - -Following command line examples have been updated for ovh virtual machine, according to indications in [Chocobozzz/PeerTube#830 (comment)](https://github.com/Chocobozzz/PeerTube/issues/830#issuecomment-425942717) - -**If you are NOT hosted on OVH virtual machine or experiencing `gyp ERR! configure error`, please switch back to [master branch](https://github.com/YunoHost-Apps/peertube_ynh)** +## Steps for installing +1. Install nodejs -### Guidelines - - 1. Require **dedicated domain** like **peertube.domain.tld**. - 1. **No LDAP** support (blocked until PeerTube core upstream implements it) - 1. URL can not be changed once selected. Choose the domain wisely. - 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) - -### Installing guide - - 1. App can be installed by **running following commands**: - - $ sudo yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix - $ cd /var/www/peertube && sudo yarn install --production --pure-lockfile - $ sudo systemctl restart peertube - 1. Admin username is : **root**. - 1. **Admin password** will be sent to the email address given at the time of the installation. - 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/production.yml**. - - ### Update Guide - 1. App can be updated with the **following commands**: - - $ sudo yunohost app upgrade -u https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix peertube - $ cd /var/www/peertube && sudo yarn install --production --pure-lockfile - $ sudo systemctl restart peertube -### Dependencies - - * NodeJS, PostgreSQL. - * On Debian Jessie,backport is added for the ffmpeg package. - -## Documentation - - * Official documentation: https://docs.joinpeertube.org/ - -## YunoHost specific features - -#### Supported architectures - -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/peertube%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/peertube/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/peertube%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/peertube/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/peertube%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/peertube/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/peertube_ynh/issues - * App website: https://joinpeertube.org/fr/ - * GitHub App website: https://github.com/Chocobozzz/PeerTube/ - * YunoHost website: https://yunohost.org/ - ---- - -Developers info ----------------- - -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/peertube_ynh/tree/testing). - -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 +$ curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - +$ sudo apt-get install -y nodejs ``` + +2. Install the peertube with OVH fix branch. + +``` +$ yunohost app install --debug https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix +``` + +3. After installation is complete run yarn install . + +``` +$ cd /var/www/peertube && yarn install --production --pure-lockfile +``` + +4. Give proper permissions to peertube + +``` +$ chown -R peertube:peertube /var/www/peertube +``` + +5. Restart peertube and check if there is any error message. + +``` +$ service peertube restart +$ journalctl -feu peertube +``` + +6. If there is no error in red in the last lines of log. Press ctrl+c to stop the logs. + +7. Go to your domain to check if peertube is running and everthing is ok. + +8. Change your root password by this command: + +``` + $ cd /var/www/peertube && NODE_CONFIG_DIR="/var/www/peertube/config/" NODE_ENV=production npm run reset-password -- -u root +``` + +Username: root +password: created in above step + +## Steps for upgrading + From 544de6cdcb780cfe2dd84b5dd6990e883d72e1be Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jun 2019 15:46:50 +0200 Subject: [PATCH 2/4] emphasis --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 983bb89..5e57d41 100644 --- a/README.md +++ b/README.md @@ -12,43 +12,43 @@ $ curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash - $ sudo apt-get install -y nodejs ``` -2. Install the peertube with OVH fix branch. +2. Install the peertube with **OVH fix** branch. ``` $ yunohost app install --debug https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix ``` -3. After installation is complete run yarn install . +3. After installation is complete run **yarn install**. ``` $ cd /var/www/peertube && yarn install --production --pure-lockfile ``` -4. Give proper permissions to peertube +4. Give proper **permissions** to peertube ``` $ chown -R peertube:peertube /var/www/peertube ``` -5. Restart peertube and check if there is any error message. +5. **Restart peertube** and check if there is any error message. ``` $ service peertube restart $ journalctl -feu peertube ``` -6. If there is no error in red in the last lines of log. Press ctrl+c to stop the logs. +6. If there is no **error in red** in the last lines of log. Press **ctrl+c** to stop the logs. -7. Go to your domain to check if peertube is running and everthing is ok. +7. Go to your **domain** to check if peertube is running and everthing is ok. -8. Change your root password by this command: +8. Change your **root password** by this command: ``` $ cd /var/www/peertube && NODE_CONFIG_DIR="/var/www/peertube/config/" NODE_ENV=production npm run reset-password -- -u root ``` -Username: root -password: created in above step +Username: **root** +password: **created in above step** ## Steps for upgrading From 1c0abdeaed8999b4c35e1b836c5544eeb2819ae6 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jun 2019 15:52:32 +0200 Subject: [PATCH 3/4] Add upgrade steps --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e57d41..19c781f 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ $ sudo apt-get install -y nodejs 2. Install the peertube with **OVH fix** branch. ``` -$ yunohost app install --debug https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix +$ yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix --debug ``` 3. After installation is complete run **yarn install**. @@ -52,3 +52,26 @@ password: **created in above step** ## Steps for upgrading +1. Upgrade peertube with **OVH fix** branch. + +``` +$ yunohost app upgrade peertube -u https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix --debug +``` + +2. After upgarde is complete run **yarn install**. + +``` +$ cd /var/www/peertube && yarn install --production --pure-lockfile +``` + +3. Give proper **permissions** to peertube + +``` +$ chown -R peertube:peertube /var/www/peertube +``` + +4. **Restart peertube** and check if there is any error message. + +``` +$ service peertube restart +``` From c5e55b75087fd41ef6e3d7482f38a00a7cdd1f45 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 23 Jun 2019 15:53:45 +0200 Subject: [PATCH 4/4] spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 19c781f..642be73 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ password: **created in above step** $ yunohost app upgrade peertube -u https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix --debug ``` -2. After upgarde is complete run **yarn install**. +2. After upgrade is complete run **yarn install**. ``` $ cd /var/www/peertube && yarn install --production --pure-lockfile