From d5c43699e086f6063926011efb3b089d19637524 Mon Sep 17 00:00:00 2001 From: Titus PiJean Date: Sun, 18 Feb 2018 23:50:28 +0100 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fdd7091..709a963 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,35 @@ -# Flarum package for YunoHost +Flarum for YunoHost +------------------- [Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server. -## Development status -Package is **working**. +**Shipped version:** 0.1.0-beta.7 -However, Flarum is in beta. That means its future updates are not guaranteed to be backward-compatible. +![](http://flarum.org/img/screenshot_2x.png) -[SSOwat integration](https://github.com/tituspijean/flarum-ext-auth-ssowat) is **non functional** and removed. +## Features -## Install -Flarum requires `composer`, which should be automatically retrieved and installed. +- All Flarum features, see its [documentation](http://flarum.org/docs/) +- SSOwat integration through a [dedicated extension](https://github.com/tituspijean/flarum-ext-auth-ssowat) -## Post-installation -Post-installation is **automated**. +## Installation +Flarum is available in the Community listing. -However, if you leave the forum title or admin user fields empty in YunoHost's form, automatic post-installation will not be launched. +You can also install it with `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 +- Optional parameters are : + - `title` :warning: if you leave it empty, you will have to perform manual post-installation. + - `language` can be English (by default), French, and German. Other languages installable after installation as any other extensions + +### Manual post-installation 1. Retrieve database password: - * It should be displayed in the log messages on top of installation page. - * Otherwise, display in command prompt with `sudo cat /etc/yunohost/apps/flarum/settings.yml | grep mysql` (Replace `flarum` by its actual app id if you are using multiple flarum instances in YunoHost) + * It should be displayed in the log messages, on top of installation page, for web installations. + * For command line installations, `sudo cat /etc/yunohost/apps/flarum/settings.yml | grep mysql` (Replace `flarum` by its actual app id if you are using multiple Flarum instances in YunoHost) 2. Go to your Flarum homepage to initiate manual post-installation.