mirror of
https://github.com/YunoHost-Apps/flarum_ynh.git
synced 2024-09-03 18:36:24 +02:00
98 lines
4.8 KiB
Markdown
98 lines
4.8 KiB
Markdown
<!--
|
||
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 pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/flarum)  
|
||
[](https://install-app.yunohost.org/?app=flarum)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Flarum 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
|
||
|
||
Flarum est une plate-forme de discussion simple pour votre site Web. C'est rapide et facile à utiliser, avec toutes les fonctionnalités dont vous avez besoin pour gérer une communauté.
|
||
|
||
**Version incluse :** 1.5.0~ynh1
|
||
|
||
|
||
**Démo :** https://discuss.flarum.org/d/21101-demos-come-to-flarum
|
||
|
||
## Captures d'écran
|
||
|
||
|
||
|
||
## 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 officiel 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/framework>
|
||
* 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.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/flarum_ynh/tree/testing --debug
|
||
ou
|
||
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>
|