mirror of
https://github.com/YunoHost-Apps/peertube_ynh.git
synced 2024-09-03 19:56:29 +02:00
Fix README
This commit is contained in:
yalh76
parent
48fdf2cb7f
commit
960a77f1ec
2 changed files with 69 additions and 161 deletions
143
README.md
143
README.md
|
|
@ -1,81 +1,76 @@
|
|||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
# ovh_fix branch for peertube_ynh
|
||||
|
||||
# PeerTube for YunoHost
|
||||
If installing on an ovh virtual machine or having `gyp ERR! configure error` please follow the steps below
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/peertube)  
|
||||
[](https://install-app.yunohost.org/?app=peertube)
|
||||
## Steps for installing
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
1. Install nodejs
|
||||
|
||||
> *This package allows you to install PeerTube quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
||||
Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser, using <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
|
||||
|
||||
|
||||
**Shipped version:** 4.0.0~ynh2
|
||||
|
||||
**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](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.
|
||||
|
||||
* 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](https://github.com/YunoHost-Apps/peertube_ynh/tree/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](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_12.x | sudo -E bash -
|
||||
$ sudo apt-get install -y nodejs
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
2. Install the peertube with **OVH fix** branch.
|
||||
|
||||
```
|
||||
$ yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix --debug
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
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 upgrade is complete run **yarn install**.
|
||||
|
||||
```
|
||||
$ cd /var/www/peertube && sudo 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
|
||||
```
|
||||
|
|
|
|||
87
README_fr.md
87
README_fr.md
|
|
@ -1,87 +0,0 @@
|
|||
# PeerTube pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/peertube)  
|
||||
[](https://install-app.yunohost.org/?app=peertube)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer PeerTube rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Plateforme de streaming vidéo fédérée (ActivityPub) utilisant P2P (BitTorrent) directement dans le navigateur Web, en utilisant <a href="https://github.com/feross/webtorrent"> WebTorrent </a>
|
||||
|
||||
|
||||
**Version incluse :** 4.0.0~ynh2
|
||||
|
||||
**Démo :** http://peertube.cpy.re
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
### Qu'est-ce que PeerTube ?
|
||||
PeerTube est une plateforme de streaming vidéo fédérée (ActivityPub) utilisant P2P (BitTorrent) directement dans le navigateur Web, en utilisant <a href="https://github.com/feross/webtorrent"> WebTorrent </a>.
|
||||
|
||||
### Pourquoi PeerTube?
|
||||
|
||||
Nous ne pouvons pas créer d'alternatives de streaming vidéo FOSS à YouTube, Dailymotion, Vimeo... avec un logiciel centralisé. Une organisation seule ne peut pas avoir assez d'argent pour payer la bande passante et le stockage vidéo de son serveur.
|
||||
Nous avons donc besoin d'un réseau décentralisé de serveurs « semant » des vidéos (comme [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)).
|
||||
Mais ce n'est pas suffisant car une vidéo pourrait devenir célèbre et surcharger le serveur. C'est la raison pour laquelle nous devons utiliser un protocole P2P pour limiter la charge du serveur. Grâce à [WebTorrent](https://github.com/feross/webtorrent), nous pouvons faire du P2P (donc BitTorrent) dans le navigateur Web, dès aujourd'hui.
|
||||
|
||||
### Pourquoi est-ce cool ?
|
||||
|
||||
Les serveurs sont gérés indépendamment par différentes personnes et organisations. Ils peuvent appliquer des politiques de modération extrêmement différentes, afin que vous puissiez en trouver ou en créer une qui correspond parfaitement à vos goûts.
|
||||
|
||||
En regardant une vidéo, vous aidez l'hébergeur à la diffuser en devenant vous-même un diffuseur de la vidéo. Chaque instance n'a pas besoin de beaucoup d'argent pour diffuser les vidéos de ses utilisateurs.
|
||||
|
||||
## Points importants à lire avant l'installation
|
||||
|
||||
1. Nécessite un **domaine dédié** comme **peertube.domain.tld**.
|
||||
1. Le nom d'utilisateur de l'administrateur est: **root**.
|
||||
1. **Le mot de passe administrateur et la configuration LDAP** seront envoyés à l'adresse email indiquée au moment de l'installation.
|
||||
1. L'URL ne peut pas être modifiée une fois sélectionnée. Choisissez judicieusement le domaine.
|
||||
1. Vous avez besoin de plus de **1 Go** de RAM. Si vous ne l'avez pas, veuillez créer une **mémoire swap**.
|
||||
|
||||
|
||||
$ dd if=/dev/zero of=/swapfile bs=1024 count=1048576
|
||||
$ mkswap /swapfile
|
||||
$ swapon /swapfile
|
||||
$ echo "/swapfile swap swap defaults 0 0" >> /etc/fstab
|
||||
|
||||
1. Cette application est **multi-instance** (vous pouvez avoir plus d'une instance PeerTube en cours d'exécution sur un serveur YunoHost)
|
||||
1. **Si vous êtes hébergé sur une machine virtuelle OVH ou rencontrez `gyp ERR! configure error`, veuillez passer à [ovh_fix](https://github.com/YunoHost-Apps/peertube_ynh/tree/ovh_fix)**
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateur
|
||||
|
||||
* L'authentification LDAP est prise en charge, les instructions de configuration sont envoyées à l'adresse email indiquée au moment de l'installation
|
||||
* L'authentification HTTP n'est pas prise en charge
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://joinpeertube.org/fr/
|
||||
* Documentation officielle de l'admin : https://docs.joinpeertube.org/
|
||||
* Dépôt de code officiel de l'app : https://github.com/Chocobozzz/PeerTube/
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_peertube
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/peertube_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/peertube_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/peertube_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade peertube -u https://github.com/YunoHost-Apps/peertube_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Reference in a new issue