flarum_ynh/README.md

# Flarum package 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 functional : installation and removal work, though upgrading, backing up and restoring don't.

[SSOwat integration](https://github.com/tituspijean/flarum-ext-auth-ssowat) is functional : users can log in, though logging out is only effective on Flarum. Only user creation hook is in place.

## Install
Flarum requires `composer`, which should be automatically retrieved and installed.

## Post-installation
Post-installation is **automated**.

However, if you leave the forum title field empty in YunoHost's form, automatic post-installation will not be launched.

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 YNH)
  
2. Go to your Flarum homepage to initiate manual post-installation.

3. Fill in the blanks about `MySQL` as follow, put the retrieved database password. The remaining blanks are up to you.

<p align="center"><img src="http://i.imgur.com/p7XmTDw.png" width="300" ></p>
Initial commit 2016-10-05 19:44:08 +02:00			`# Flarum package for YunoHost`
			`[Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server.`

Update README.md 2017-02-28 07:19:47 +01:00			`## Development status`
			`Package is functional : installation and removal work, though upgrading, backing up and restoring don't.`

			`[SSOwat integration](https://github.com/tituspijean/flarum-ext-auth-ssowat) is functional : users can log in, though logging out is only effective on Flarum. Only user creation hook is in place.`

Initial commit 2016-10-05 19:44:08 +02:00			`## Install`
			Flarum requires `composer`, which should be automatically retrieved and installed.

			`## Post-installation`
Update README.md For automatic post-installation 2016-10-19 20:16:19 +02:00			`Post-installation is automated.`

			`However, if you leave the forum title field empty in YunoHost's form, automatic post-installation will not be launched.`
Initial commit 2016-10-05 19:44:08 +02:00
			`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 YNH)

Update README.md For automatic post-installation 2016-10-19 20:16:19 +02:00			`2. Go to your Flarum homepage to initiate manual post-installation.`
Initial commit 2016-10-05 19:44:08 +02:00
			3. Fill in the blanks about `MySQL` as follow, put the retrieved database password. The remaining blanks are up to you.

Update README.md For automatic post-installation 2016-10-19 20:16:19 +02:00			`<p align="center"><img src="http://i.imgur.com/p7XmTDw.png" width="300" ></p>`