1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/flarum_ynh.git synced 2024-09-03 18:36:24 +02:00
flarum_ynh/README.md

97 lines
4 KiB
Markdown
Raw Normal View History

2021-05-16 11:58:34 +02:00
<!--
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
2022-05-31 20:49:55 +02:00
[![Integration level](https://dash.yunohost.org/integration/flarum.svg)](https://dash.yunohost.org/appci/app/flarum) ![Working status](https://ci-apps.yunohost.org/ci/badges/flarum.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/flarum.maintain.svg)
2021-06-04 18:33:11 +02:00
[![Install Flarum with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=flarum)
2021-05-16 11:58:34 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-06-04 18:33:11 +02:00
> *This package allows you to install Flarum quickly and simply on a YunoHost server.
2020-06-12 01:55:21 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2016-10-05 19:44:08 +02:00
2020-06-12 01:55:21 +02:00
## Overview
2018-02-17 22:15:29 +01:00
2021-09-22 08:14:47 +02:00
Flarum is a simple discussion platform for your website. It's fast and easy to use, with all the features you need to run a successful community.
2021-05-16 11:58:34 +02:00
2022-05-17 08:28:24 +02:00
**Shipped version:** 1.3.0~ynh1
2021-05-16 11:58:34 +02:00
**Demo:** https://discuss.flarum.org/d/21101-demos-come-to-flarum
2020-06-12 01:55:21 +02:00
## Screenshots
2022-05-31 20:49:55 +02:00
![Screenshot of Flarum](./doc/screenshots/beta16.jpg)
2019-08-24 12:54:18 +02:00
2021-05-16 11:58:34 +02:00
## Disclaimers / important information
2021-05-16 11:58:34 +02:00
### 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.
2018-02-18 23:50:28 +01:00
2021-05-16 11:58:34 +02:00
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
2020-03-14 21:22:33 +01:00
2021-05-16 11:58:34 +02:00
Note that, for the moment, all third-party extensions are removed upon upgrading.
2020-03-14 21:22:33 +01:00
2021-05-16 11:58:34 +02:00
### Adding extensions
Flarum does not offer to install extensions from its admin panel yet, so you need to use the command line.
2020-03-14 21:22:33 +01:00
2021-04-29 00:20:51 +02:00
Replace `flarum` with your app ID in case of multiple installations.
2020-03-14 21:22:33 +01:00
Replace `vendor/extension` with the appropriate names. Read the extension documentation if it requires additional steps.
```bash
2021-03-02 18:03:02 +01:00
sudo su
2020-03-14 21:22:33 +01:00
app=flarum
cd /var/www/$app
sudo -u $app php7.3 composer.phar require vendor/extension
```
2021-05-16 11:58:34 +02:00
#### Troubleshooting
2021-05-16 11:58:34 +02:00
##### `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).
2018-09-01 14:34:01 +02:00
2019-08-24 12:54:18 +02:00
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).
2018-09-01 14:34:01 +02:00
2019-08-24 12:54:18 +02:00
Reload PHP-FPM with `sudo service php*php_version*-fpm reload`.
2021-05-16 11:58:34 +02:00
##### Upload limit
If you are facing an error while uploading large files into the forum, PHP may be limiting file upload.
2018-09-01 14:34:01 +02:00
2019-08-24 12:54:18 +02:00
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).
2018-09-01 14:34:01 +02:00
2019-08-24 12:54:18 +02:00
Reload PHP-FPM with `sudo service php*php_version*-fpm reload`.
2020-06-12 01:55:21 +02:00
2021-05-16 11:58:34 +02:00
## Documentation and resources
2020-06-12 01:55:21 +02:00
2022-05-31 20:49:55 +02:00
* Official app website: <https://flarum.org>
* Official admin documentation: <https://docs.flarum.org>
* Upstream app code repository: <https://github.com/flarum/framework>
* YunoHost documentation for this app: <https://yunohost.org/app_flarum>
* Report a bug: <https://github.com/YunoHost-Apps/flarum_ynh/issues>
2020-06-12 01:55:21 +02:00
2020-10-15 21:26:14 +02:00
## Developer info
2020-06-12 01:55:21 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/flarum_ynh/tree/testing).
To try the testing branch, please proceed like that.
2022-05-31 20:49:55 +02:00
``` bash
2020-06-12 01:55:21 +02:00
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
```
2021-05-16 11:58:34 +02:00
2022-05-31 20:49:55 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>