diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 3afed93..8ba3b3f 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -1,22 +1 @@ -### IMPORTANT POINT TO READ BEFORE INSTALLING -* 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)** -* HTTP auth is not supported -* Do not modify the `/var/www//conf/production.yaml` file, because it will be overridden in the next upgrade. Please instead either change them though the web interface or create a `/var/www//conf/local.yaml` file, assign it the same owner, group and rights than for `conf/production.yaml` and fill there your specific settings. - * Note: when the same option have different values in `production.yaml` and `local.yaml` files, only the value in `local.yaml` is taken into account. - -### PLUGINS -* LDAP auth is supported, LDAP configuration will be sent to the email address given at the time of the installation. -* PeerTube plugin livechat is installed with Prosody. To enable, just select «Prosody server controlled by Peertube» as chat mode in the plugin configutation of the PeerTube admin page -* During install, because of Prosody, Metronome is disabled +* Do not modify the `/var/www//conf/production.yaml` file, because it will be overridden in the next upgrade. Please instead either change them though the web interface, which stores specific local settings in a separate configuration file. diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md deleted file mode 100644 index 3bf129e..0000000 --- a/doc/ADMIN_fr.md +++ /dev/null @@ -1,23 +0,0 @@ -### Points importants à lire avant l'installation -* Nécessite un **domaine dédié** comme **peertube.domain.tld**. -* Le nom d'utilisateur de l'administrateur est: **root**. -* **Le mot de passe administrateur et la configuration LDAP** seront envoyés à l'adresse email indiquée au moment de l'installation. -* L'URL ne peut pas être modifiée une fois sélectionnée. Choisissez judicieusement le domaine. -* 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 - -* Cette application est **multi-instance** (vous pouvez avoir plus d'une instance PeerTube en cours d'exécution sur un serveur YunoHost) -* **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)** -* L'authentification HTTP n'est pas supportée -* Ne modifiez pas le fichier `/var/www//conf/production.yaml`, car il sera remplacé à la prochaine mise à jour. À la place, veuillez modifier la configuration via l'interface web ou créer et remplir le fichier `/var/www//conf/local.yaml`, assignez-lui les mêmes propriétaire, groupe et droits que pour `conf/production.yaml` et y remplir vos options spécifiques. - * Note: si la même option contient différentes valeurs dans les fichiers `conf/production.yaml` et `conf/local.yaml`, seule la valeur dans `conf/local.yaml` sera prise en compte. - -#### PLUGINS - -* L'authentification LDAP est prise en charge, les instructions de configuration sont envoyées à l'adresse email indiquée au moment de l'installation -* Le plugin PeerTube livechat est installé ainsi que Prosody. pour l'activer, sélectionner «Prosody server controlled by Peertube» dans le paramétre chat mode du plugin dans la page d'administration de PeerTube. -* Pendant l'installation, à cause de Prosody, Metronome est désactivé. diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md index 34d364b..9197b62 100644 --- a/doc/POST_INSTALL.md +++ b/doc/POST_INSTALL.md @@ -1,15 +1,12 @@ -__APP__ was successfully installed :) - -Please open your __APP__ domain: https://__DOMAIN____PATH__ - -The admin username is: root -The admin password is: __ADMIN_PASS__ +- __APP__ can now be accessed at [https://__DOMAIN____PATH__](https://__DOMAIN____PATH__) +- The admin username is: root +- The admin password is: __ADMIN_PASS__ To make PeerTube Live available, you also need to make the TCP port __PORT_RTMP__ available from internet (For example, opening the port on your ISP box if it's not automatically done). -To enable LDAP authentication open https://__DOMAIN____PATH__admin/plugins/show/peertube-plugin-auth-ldap -Complete with the following informations : -- URL: ldap://127.0.0.1 -- Insecure TLS : checked -- Search base : ou=users,dc=yunohost,dc=org +To enable LDAP authentication, you should open [https://__DOMAIN____PATH__admin/plugins/show/peertube-plugin-auth-ldap](https://__DOMAIN____PATH__admin/plugins/show/peertube-plugin-auth-ldap) and complete with the following informations : +- URL: `ldap://127.0.0.1` +- Insecure TLS: `checked` +- Search base: `ou=users,dc=yunohost,dc=org` + All YunoHost users will be allowed to login as peertube user. diff --git a/manifest.toml b/manifest.toml index bdc5977..ef1b8a9 100644 --- a/manifest.toml +++ b/manifest.toml @@ -26,8 +26,8 @@ ldap = true sso = false disk = "50M" -ram.build = "50M" -ram.runtime = "50M" +ram.build = "1G" +ram.runtime = "1G" [install] [install.domain]