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

Flarum, an open-source forum software, packaged for YunoHost

closember flarum forum yunohost yunohost-apps

Find a file

Éric Gaspar b8c78221b9 Set SVG badge		2020-12-27 22:21:14 +01:00
.github/ISSUE_TEMPLATE	[enh] clearer versions field	2019-10-17 23:50:15 +02:00
conf	Do not use www-data as PHP-FPM group	2020-12-25 19:36:30 +01:00
scripts	Fix linter warnings	2020-12-23 23:04:30 +01:00
.gitattributes	👾 Added .gitattributes	2016-10-05 19:43:44 +02:00
.gitignore	Initial commit	2016-10-05 19:44:08 +02:00
check_process	remove bazaar	2020-06-22 09:31:01 +02:00
issue_template.md	Apply last example_ynh	2020-06-22 09:31:01 +02:00
LICENSE	Initial commit	2016-10-05 19:44:08 +02:00
manifest.json	Bump package version	2020-12-05 12:40:56 +01:00
pull_request_template.md	Apply last example_ynh	2020-06-22 09:31:01 +02:00
README.md	Set SVG badge	2020-12-27 22:21:14 +01:00

README.md

Flarum for YunoHost

This package allows you to install Flarum quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Flarum, an open-source forum software, packaged for YunoHost, a self-hosting server operating server.

Shipped version: 0.1.0-beta.14

Screenshots

Features

All Flarum features, see its documentation
SSOwat integration through a dedicated extension.

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:

domain
path
admin, among the YunoHosts users
public, true by default, for guests to read the forum
title of the forum
language can be English en (by default), French fr, and German de. Other languages are installable after installation like any other extensions

After installation, simply open your browser to Flarum's page. First loading may be a bit longer as assets are generated.

Upgrading

Note that all third-party extensions are removed upon upgrading.

Adding extensions after installation

Replace flarum with your app ID in case of multiple installation. Replace vendor/extension with the appropriate names. Read the extension documentation if it requires additional steps.

app=flarum
cd /var/www/$app
sudo -u $app php7.3 composer.phar require vendor/extension

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.

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

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

Supported architectures

x86-64 -
ARMv8-A -

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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