Use README generator

README.md

@@ -1,46 +1,60 @@
+
+
+---
+
+<!--
+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.
+-->
+
 # Flarum for YunoHost
 
 [![Integration level](https://dash.yunohost.org/integration/flarum.svg)](https://dash.yunohost.org/appci/app/flarum) ![](https://ci-apps.yunohost.org/ci/badges/flarum.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/flarum.maintain.svg)
-[![Install Flarum with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flarum)
+[![Install flarum with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flarum)
 
-> *This package allows you to install Flarum quickly and simply on a YunoHost server.  
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install flarum 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
-[Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server.
 
-**Shipped version:** 0.1.0-beta.16
+Next-generation forum made simple.
+
+**Shipped version:** 0.1.0.16~ynh4
+
+**Demo:** https://discuss.flarum.org/d/21101-demos-come-to-flarum
+
 
 ## Screenshots
 
-![](https://flarum.org/assets/img/home-screenshot.png)
 
-## Features
+   ![](./doc/screenshots/beta16.jpg)
 
-- All Flarum features, see its [documentation](http://flarum.org/docs/)
-- LDAP integration through a [dedicated extension](https://github.com/tituspijean/flarum-ext-auth-ldap).
 
-## Installation
 
-This Flarum package can be installed through:
-- YunoHost's webadmin, in the Community listing
-- YunoHost's CLI: `yunohost app install https://github.com/YunoHost-Apps/flarum_ynh`.
 
-Required parameters are:
+## Disclaimers / important information
-- `domain`
+
-- `path`
+### Installing
-- `admin`, among the YunoHosts users
+
-- `public`, *true* by default, for guests to read the forum
+- The installation requires at least 1GB of free memory. A swap file of this size will be created if needed.
-- `title` of the forum
+- You can select the default language (among English `en` by default, French `fr`, and German `de`). Other languages can be added after installation like any other extension.
-- `language` can be English `en` (by default), French `fr`, and German `de`. Other languages are installable after installation like any other extensions
+
+### Using
 
 After installation, simply open your browser to Flarum's page. First loading may be a bit longer as assets are generated.
 
-## Upgrading
+This app allows your YunoHost users to log in with a [dedicated LDAP extension](https://github.com/tituspijean/flarum-ext-auth-ldap). By default, the standard logging method is hidden.
+To allow non-YunoHost users to log in, the LDAP extension setting is in the admin panel.
 
-Note that all third-party extensions are removed upon upgrading.
+### Upgrading
 
-## Adding extensions after installation
+Note that, for the moment, all third-party extensions are removed upon upgrading.
+
+### Adding extensions
+
+Flarum does not offer to install extensions from its admin panel yet, so you need to use the command line.
 
 Replace `flarum` with your app ID in case of multiple installations.
 Replace `vendor/extension` with the appropriate names. Read the extension documentation if it requires additional steps.
@@ -52,57 +66,32 @@ cd /var/www/$app
 sudo -u $app php7.3 composer.phar require vendor/extension
 ```
 
-## Troubleshooting
+#### Troubleshooting
 
-### `Low memory` errors
+##### `Timeout` errors
-A swapfile will enable your system to extend its limited memory through its disk capacity. The following commands will create a 1 GB swapfile.
-```
-sudo dd if=/dev/zero of=/swapfile bs=1024 count=1024000
-sudo chmod 600 /swapfile
-sudo mkswap /swapfile
-sudo swapon /swapfile
-```
-
-Then add this line in `/etc/fstab`:
-```
-/swapfile none swap sw 0 0
-```
-
-Reboot the system and try the installation again.
-
-### `Timeout` errors
 Some users have reported a successful installation, but get a blank page due to a `timeout` on a PHP script that prepares the forum assests (`Minify.php`, notably).
 
 In `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, you can increase the `max_execution_time` and `max_input_time` limits (both values are in seconds if nothing is specified).
 
 Reload PHP-FPM with `sudo service php*php_version*-fpm reload`.
 
-### Upload limit
+##### Upload limit
 If you are facing an error while uploading large files into the forum, PHP may be limiting file upload.
 
 In `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, you can uncomment (remove `;` at the beginning of the line) and increase the values of `upload_max_filesize` and `post_max_size` (both values are in bytes).
 
 Reload PHP-FPM with `sudo service php*php_version*-fpm reload`.
 
-## Documentation
 
- * Official documentation: https://flarum.org/docs/
 
-## YunoHost specific features
+## Documentation and resources
 
-#### Supported architectures
+* Official app website: https://flarum.org
-
-* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/flarum%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/flarum/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/flarum%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/flarum/)
-
-## Links
 
+* Official admin documentation: https://docs.flarum.org
+* Upstream app code repository:  https://github.com/flarum/flarum
+* YunoHost documentation for this app: https://yunohost.org/app_flarum
 * Report a bug: https://github.com/YunoHost-Apps/flarum_ynh/issues
- * App website: https://flarum.org/
- * Upstream app repository: https://github.com/flarum/flarum
- * YunoHost website: https://yunohost.org/
-
----
 
 ## Developer info
 
@@ -114,3 +103,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/flarum_ynh/tree/testi
 or
 sudo yunohost app upgrade flarum -u https://github.com/YunoHost-Apps/flarum_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** https://yunohost.org/packaging_apps

README_fr.md

@@ -0,0 +1,100 @@
+# Flarum pour YunoHost
+
+[![Niveau d'intégration](https://dash.yunohost.org/integration/flarum.svg)](https://dash.yunohost.org/appci/app/flarum) ![](https://ci-apps.yunohost.org/ci/badges/flarum.status.svg)  ![](https://ci-apps.yunohost.org/ci/badges/flarum.maintain.svg)
+[![Installer flarum avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flarum)
+
+*[Read this readme in english.](./README.md)*
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install flarum 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.*
+
+## Vue d'ensemble
+
+Un forum de nouvelle génération, simplement.
+
+**Version incluse:** 0.1.0.16~ynh4
+
+**Démo:** https://discuss.flarum.org/d/21101-demos-come-to-flarum
+
+
+## Captures d'écran
+
+
+   ![](./doc/screenshots/beta16.jpg)
+
+
+
+
+## Avertissements / informations importantes
+
+### Installation
+
+- L'installation nécessite au moins 1 Go de mémoire vive libre. Un fichier *swap* de cette taille sera créé si nécessaire.
+- Vous pouvez sélectionner la langue par défaut dans les paramètres d'installation (parmi l'anglais `en`, le français `fr` et l'allemand `de`). Les autres langues sont installables comme n'importe quelle autre extension.
+
+### Utilisation
+
+Après l'installation, ouvrez simplement votre navigateur à la page de Flarum. Le premier chargement peut être un peu retardé par la génération du cache.
+
+Cette app permet à vos utilisateurs enregistrés dans YunoHost de se connecter avec une [extension LDAP dédiée](https://github.com/tituspijean/flarum-ext-auth-ldap). Par défaut, la méthode de connexion standard est cachée.
+Pour permettre à des utilisateurs non-YunoHost de se connecter, référez-vous au menu de configuration de l'extension LDAP dans le panneau d'administration de Flarum.
+
+### Mise à jour
+
+Notez que, pour le moment, toute extension tierce est désinstallée lors d'une mise à jour.
+Leurs données et paramètres restent dans la base de donnée de Flarum, seule une réinstallation est nécessaire.
+
+### Ajouter des extensions
+
+Flarum ne permet pas encore d'installer des extensions depuis son interface d'administration ; vous devrez donc utiliser la ligne de commande.
+
+Remplacez `flarum` par l'ID de votre app en cas de multiple installations.
+Remplacez `vendor/extension` par les noms adéquats. Référez-vous à la documentation de l'extension pour vérifier qu'elle ne nécessite pas de configuration supplémentaire.
+
+```bash
+sudo su
+app=flarum
+cd /var/www/$app
+sudo -u $app php7.3 composer.phar require vendor/extension
+```
+
+#### Dépannage
+
+##### Erreurs de `timeout`
+Quelques utilisateurs rapportent qu'ils font fassent à une page blanche due à une erreur de `timeout` dans un script PHP qui prépare le cache (`Minify.php`, notamment).
+
+Dans `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, vous pouvez augmenter les limites `max_execution_time` et `max_input_time` (les deux valeurs sont en secondes si vous ne précisez pas d'unité).
+
+Rechargez PHP-FPM avec `sudo service php*php_version*-fpm reload`.
+
+##### Limite de téléversement
+Si vous avez une erreur lors du chargement de gros fichiers dans le forum, PHP pourrait être en train de limiter les téléversements.
+
+Dans `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, vous pouvez décommenter (enlevez `;` au début de la ligne) et augmenter les valeurs de `upload_max_filesize` de `post_max_size` (les deux valeurs sont en octets).
+
+Rechargez PHP-FPM avec `sudo service php*php_version*-fpm reload`.
+
+
+
+## Documentations et ressources
+
+* Site official de l'app : https://flarum.org
+
+* Documentation officielle de l'admin: https://docs.flarum.org
+* Dépôt de code officiel de l'app:  https://github.com/flarum/flarum
+* Documentation YunoHost pour cette app: https://yunohost.org/app_flarum
+* Signaler un bug: https://github.com/YunoHost-Apps/flarum_ynh/issues
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/flarum_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+```
+sudo yunohost app install https://github.com/YunoHost-Apps/flarum_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade flarum -u https://github.com/YunoHost-Apps/flarum_ynh/tree/testing --debug
+```
+
+**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps

doc/DISCLAIMER.md

@@ -0,0 +1,45 @@
+### Installing
+
+- The installation requires at least 1GB of free memory. A swap file of this size will be created if needed.
+- You can select the default language (among English `en` by default, French `fr`, and German `de`). Other languages can be added after installation like any other extension.
+
+### Using
+
+After installation, simply open your browser to Flarum's page. First loading may be a bit longer as assets are generated.
+
+This app allows your YunoHost users to log in with a [dedicated LDAP extension](https://github.com/tituspijean/flarum-ext-auth-ldap). By default, the standard logging method is hidden.
+To allow non-YunoHost users to log in, the LDAP extension setting is in the admin panel.
+
+### Upgrading
+
+Note that, for the moment, all third-party extensions are removed upon upgrading.
+
+### Adding extensions
+
+Flarum does not offer to install extensions from its admin panel yet, so you need to use the command line.
+
+Replace `flarum` with your app ID in case of multiple installations.
+Replace `vendor/extension` with the appropriate names. Read the extension documentation if it requires additional steps.
+
+```bash
+sudo su
+app=flarum
+cd /var/www/$app
+sudo -u $app php7.3 composer.phar require vendor/extension
+```
+
+#### Troubleshooting
+
+##### `Timeout` errors
+Some users have reported a successful installation, but get a blank page due to a `timeout` on a PHP script that prepares the forum assests (`Minify.php`, notably).
+
+In `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, you can increase the `max_execution_time` and `max_input_time` limits (both values are in seconds if nothing is specified).
+
+Reload PHP-FPM with `sudo service php*php_version*-fpm reload`.
+
+##### Upload limit
+If you are facing an error while uploading large files into the forum, PHP may be limiting file upload.
+
+In `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, you can uncomment (remove `;` at the beginning of the line) and increase the values of `upload_max_filesize` and `post_max_size` (both values are in bytes).
+
+Reload PHP-FPM with `sudo service php*php_version*-fpm reload`.

doc/DISCLAIMER_fr.md

@@ -0,0 +1,46 @@
+### Installation
+
+- L'installation nécessite au moins 1 Go de mémoire vive libre. Un fichier *swap* de cette taille sera créé si nécessaire.
+- Vous pouvez sélectionner la langue par défaut dans les paramètres d'installation (parmi l'anglais `en`, le français `fr` et l'allemand `de`). Les autres langues sont installables comme n'importe quelle autre extension.
+
+### Utilisation
+
+Après l'installation, ouvrez simplement votre navigateur à la page de Flarum. Le premier chargement peut être un peu retardé par la génération du cache.
+
+Cette app permet à vos utilisateurs enregistrés dans YunoHost de se connecter avec une [extension LDAP dédiée](https://github.com/tituspijean/flarum-ext-auth-ldap). Par défaut, la méthode de connexion standard est cachée.
+Pour permettre à des utilisateurs non-YunoHost de se connecter, référez-vous au menu de configuration de l'extension LDAP dans le panneau d'administration de Flarum.
+
+### Mise à jour
+
+Notez que, pour le moment, toute extension tierce est désinstallée lors d'une mise à jour.
+Leurs données et paramètres restent dans la base de donnée de Flarum, seule une réinstallation est nécessaire.
+
+### Ajouter des extensions
+
+Flarum ne permet pas encore d'installer des extensions depuis son interface d'administration ; vous devrez donc utiliser la ligne de commande.
+
+Remplacez `flarum` par l'ID de votre app en cas de multiple installations.
+Remplacez `vendor/extension` par les noms adéquats. Référez-vous à la documentation de l'extension pour vérifier qu'elle ne nécessite pas de configuration supplémentaire.
+
+```bash
+sudo su
+app=flarum
+cd /var/www/$app
+sudo -u $app php7.3 composer.phar require vendor/extension
+```
+
+#### Dépannage
+
+##### Erreurs de `timeout`
+Quelques utilisateurs rapportent qu'ils font fassent à une page blanche due à une erreur de `timeout` dans un script PHP qui prépare le cache (`Minify.php`, notamment).
+
+Dans `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, vous pouvez augmenter les limites `max_execution_time` et `max_input_time` (les deux valeurs sont en secondes si vous ne précisez pas d'unité).
+
+Rechargez PHP-FPM avec `sudo service php*php_version*-fpm reload`.
+
+##### Limite de téléversement
+Si vous avez une erreur lors du chargement de gros fichiers dans le forum, PHP pourrait être en train de limiter les téléversements.
+
+Dans `/etc/php/*php_version*/fpm/pool.d/*app_id*.conf`, vous pouvez décommenter (enlevez `;` au début de la ligne) et augmenter les valeurs de `upload_max_filesize` de `post_max_size` (les deux valeurs sont en octets).
+
+Rechargez PHP-FPM avec `sudo service php*php_version*-fpm reload`.

manifest.json

@@ -9,6 +9,13 @@
     },
     "version": "0.1.0.16~ynh4",
     "url": "http://flarum.org/",
+    "upstream": {
+        "license": "MIT",
+        "website": "https://flarum.org",
+        "demo": "https://discuss.flarum.org/d/21101-demos-come-to-flarum",
+        "admindoc": "https://docs.flarum.org",
+        "code": "https://github.com/flarum/flarum"
+    },
     "license": "MIT",
     "maintainer": {
         "name": "tituspijean",