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

[mod] README style and minor reformulation

Browse source
This commit is contained in:
tituspijean 2018-09-01 14:20:50 +02:00
parent e078f766cd
commit 3e5e25e1cf
1 changed files with 21 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,9 +1,6 @@
Flarum for YunoHost # Flarum for YunoHost
-------------------
[![Integration level](https://dash.yunohost.org/integration/flarum.svg)](https://dash.yunohost.org/appci/app/flarum) [![Install Hubzilla with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=flarum) [![Integration level](https://dash.yunohost.org/integration/flarum.svg)](https://dash.yunohost.org/appci/app/flarum)
[![Install Hubzilla with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=flarum)
[Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server. [Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server.
@ -14,14 +11,14 @@ Flarum for YunoHost
## Features ## Features
- All Flarum features, see its [documentation](http://flarum.org/docs/) - All Flarum features, see its [documentation](http://flarum.org/docs/)
- SSOwat integration through a [dedicated extension](https://github.com/tituspijean/flarum-ext-auth-ssowat) - SSOwat integration through a [dedicated extension](https://github.com/tituspijean/flarum-ext-auth-ssowat).
## Installation ## Installation
Flarum is available in the Community listing. This Flarum package can be installed
- through YunoHost's webadmin, in the Community listing
- through YunoHost's CLI: `yunohost app install https://github.com/YunoHost-Apps/flarum_ynh`.
You can also install it with `yunohost app install https://github.com/YunoHost-Apps/flarum_ynh`. Required parameters are :
- Required parameters are :
- `domain` - `domain`
- `path` - `path`
- `admin`, among the YunoHosts users - `admin`, among the YunoHosts users
@ -30,8 +27,11 @@ You can also install it with `yunohost app install https://github.com/YunoHost-A
- `language` can be English (by default), French, and German. Other languages installable after installation as any other extensions - `language` can be English (by default), French, and German. Other languages installable after installation as any other extensions
- `bazaar_extension` to install the extension marketplace (*false* by default), to avoid using the command line to add new extensions. - `bazaar_extension` to install the extension marketplace (*false* by default), to avoid using the command line to add new extensions.
### Performance issues and loading errors After installation, simply open your browser to Flarum's page. First loading may be a bit longer as assets are generated.
#### `Low memory` errors
## Troubleshooting
### `Low memory` 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. 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 dd if=/dev/zero of=/swapfile bs=1024 count=1024000
@ -44,14 +44,15 @@ Then add this line in `/etc/fstab`:
``` ```
/swapfile none swap sw 0 0 /swapfile none swap sw 0 0
``` ```
Reboot the system and try the installation again. Reboot the system and try the installation again.
#### `Timeout` errors ### `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). 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/7.0/fpm/conf.d/20-{APPID}.ini`, you can increase the `max_execution_time` and `max_input_time` limits (both values are in seconds if nothing is specified). In `/etc/php/7.0/fpm/conf.d/20-{APPID}.ini`, 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 php7.0-fpm reload`. Reload PHP-FPM with `sudo service php7.0-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. If you are facing an error while uploading large files into the forum, PHP may be limiting file upload.
In `/etc/php/7.0/fpm/conf.d/20-{APPID}.ini`, 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). In `/etc/php/7.0/fpm/conf.d/20-{APPID}.ini`, 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 php7.0-fpm reload`. Reload PHP-FPM with `sudo service php7.0-fpm reload`.