From 4858315636f379bb54b78fa325926c8ea10ad1dd Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Tue, 21 Feb 2023 21:19:22 +0000 Subject: [PATCH] Auto-update README --- README.md | 48 ------------------------------------------------ README_fr.md | 49 ------------------------------------------------- 2 files changed, 97 deletions(-) diff --git a/README.md b/README.md index 309fbbc..58c76f5 100644 --- a/README.md +++ b/README.md @@ -26,54 +26,6 @@ Flarum is a simple discussion platform for your website. It's fast and easy to u ![Screenshot of Flarum](./doc/screenshots/beta16.jpg) -## Disclaimers / important information - -### 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.4 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`. - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 5915f77..dff0425 100644 --- a/README_fr.md +++ b/README_fr.md @@ -26,55 +26,6 @@ Flarum est une plate-forme de discussion simple pour votre site Web. C'est rapid ![Capture d’écran de Flarum](./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.4 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 officiel de l’app :