foodsoft/plugins/discourse/README.md

27 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2017-09-22 01:14:48 +02:00
FoodsoftDiscourse
=================
This plugin adds the possibility to log in via Discourse or act as and SSO
provider for Discourse. A new button is added to the login screen if enabled.
2017-09-22 01:14:48 +02:00
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 for 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.
If `discourse_sso` is set to `true` Foodsoft will act as an SSO provider for
Discourse. The `sso url` for Discourse is `/discourse/sso` relative to root url
of Foodsoft (e.g. `https://foodsoft.example.com/f/discourse/sso`).
2017-09-22 01:14:48 +02:00
This plugin is part of the foodsoft package and uses the AGPL-3 license (see
2017-09-22 01:14:48 +02:00
foodsoft's LICENSE for the full license text).