foodsoft/plugins/discourse/README.md
2017-09-22 13:58:00 +02:00

22 lines
910 B
Markdown

FoodsoftDiscourse
=================
This plugin adds the possibility to log in via Discourse. A new button is added
to the login screen.
This plugin is enabled by default in foodsoft, so you don't need to do anything
to install it. If you still want to, for example when it has been disabled,
add the following to foodsoft's Gemfile:
```Gemfile
gem 'foodsoft_discourse', path: 'plugins/foodsoft_discourse'
```
This plugin introduces the foodcoop config option `discourse_url`, which takes
the URL fo the Discourse installation (e.g. `https://forum.example.com`) and the
config option `discourse_sso_secret`, which must be set to the same values as
configured in the `sso secret` setting of the Discourse installation. The plugin
will be disabled if not both config options are set.
This plugin is part of the foodsoft package and uses the GPL-3 license (see
foodsoft's LICENSE for the full license text).