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
Flarum, an open-source forum software, packaged for YunoHost
184 commits 2 branches 0 tags 764 KiB
Shell 100%
Find a file
tituspijean a2fc1df991 Add issue template 
## Problem
- Users may be at loss about how to describe their issue and how to report bugs.

## Solution
- To help us help them help us all (*à la* GLaDOS), I propose a simple issue template that guides the user. It first directs them between this repo, the SSOwat extension's and Flarum florum. Then important information and how to get them are listed.

## PR Status
- [x] Work finished.
- [x] Can be reviewed and tested.

## Validation
---
*Minor decision*
- [ ] **Code review** : 
- [ ] **Approval (LGTM)** : 
- [ ] **Approval (LGTM)** :
2018-09-13 18:17:36 +02:00
.github/ISSUE_TEMPLATE Add issue template 2018-09-13 18:17:36 +02:00
conf Add php-fpm.ini to increase time and memory limits 2018-08-22 22:11:43 +02:00
scripts Merge pull request #98 from YunoHost-Apps/fix-upgrade 2018-09-04 12:01:46 +02: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 Fix upgrade test 2018-07-26 16:48:12 +02:00
LICENSE Initial commit 2016-10-05 19:44:08 +02:00
manifest.json [mod] manifest.json: remove "required for postinstall" text about admin user too 2018-08-31 16:50:37 +02:00
README.md [mod] README style and typo fix 2018-09-01 14:34:01 +02:00

README.md

Flarum for YunoHost

Install Hubzilla with YunoHost

Integration level Flarum version

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

Features

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 (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.

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

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/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.

Upload limit

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).

Reload PHP-FPM with sudo service php7.0-fpm reload.