flarum_ynh/doc/DISCLAIMER.md

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

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

Note that, for the moment, all third-party extensions are removed upon upgrading.

### Adding extensions

Flarum does not offer to install extensions from its admin panel yet, so you need to use the command line.

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

```bash
sudo su
app=flarum
cd /var/www/$app
sudo -u $app php7.4 composer.phar require vendor/extension
```

#### Troubleshooting

##### `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`.
Use README generator 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.`

			`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`

			`Note that, for the moment, all third-party extensions are removed upon upgrading.`

			`### Adding extensions`

			`Flarum does not offer to install extensions from its admin panel yet, so you need to use the command line.`

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

			```bash
			`sudo su`
			`app=flarum`
			`cd /var/www/$app`
Fix PHP version in DISCLAIMER (#199) Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-10-16 10:12:46 +02:00			`sudo -u $app php7.4 composer.phar require vendor/extension`
Use README generator 2021-05-16 11:58:34 +02:00			```

			`#### Troubleshooting`

			##### `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 phpphp_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 phpphp_version-fpm reload`.