You need to create a random token (for security purposes it is better if this is long 40 characters, you can use this tool to make one) and put it into the api_keys
table of your Flarum database.
You only need to set the key
column and the user_id
one. In the first one write your new generated token and in the latter your admin user id.
Before the following steps, be sure to have done pre-installation steps.
You can find the plugin in the WordPress plugin Directory.
So you can download it from your WP site in Plugins --> Add new.
Warning! This method can fail! If the plugin activation fails then try one of the methods below
Download the zip from the releases page and upload it to WordPress.
/wp-content/plugins/
) of your WordPress instance and rename the folder to sso-flarum
).composer install --no-dev
PHP versions will be supported until its EOL.
If Flarum core changes PHP version before the official EOL, I’ll update too the version accordingly to what they have chosen.
You currently have two ways to upgrade the plugin. If there are breaking changes in the version you want to update to, you may also have to follow the version-specific upgrade notes below.
Upgrade the plugin like any other plugin from the WordPress Admin Area.
Download the zip from the releases page and upload it to WordPress Add Plugin page (if WP < 5.5 you must have installed the ZIP upgrading plugin) or unzip it and upload the files/folders to the server in directory YOUR_WP/wp-content/plugins/sso-flarum
The other breaking changes from PHP plugin are already added to the plugin, so you don’t have to worry about them!
You can open settings of the plugin from the Settings --> Flarum SSO plugin menu. See below for help about settings.
Here are explained the options of the plugin.
true
. Set this to false
ONLY if you don’t have an SSL certificate or you’re developing on your local server such as XAMPP. More details on https://docs.guzzlephp.org/en/stable/request-options.html#verify.This addon is premium, which means that requires an active subscription to be used.
Feature: Sync users’ memberships with Flarum.
You can pay with your preferred gateway.
Gateway name | Stripe | PayPal |
---|---|---|
Price | 3,49 € | 3,49 € |
Commissions | 5% | 10% |
Total Price | 3,69 € | 3,84 € |
Payment buttons | Pay with Stripe |
Gateway name | Stripe | PayPal |
---|---|---|
Price | 34,99 € | 34,99 € |
Commissions | 5% | 10% |
Total Price | 36,74 € | 38,49 € |
Payment buttons | Pay with Stripe |
Before buying read the Pricing notes!
This addon is premium, which means that requires an active subscription to be used.
Feature: Use JWT (Json Web Token) instead of standard API Auth in order to gain more security during the authentication procedure.
You can pay with your preferred gateway.
Gateway name | Stripe | PayPal |
---|---|---|
Price | 3,49 € | 3,49 € |
Commissions | 5% | 10% |
Total Price | 3,69 € | 3,84 € |
Payment buttons | Pay with Stripe |
Gateway name | Stripe | PayPal |
---|---|---|
Price | 34,99 € | 34,99 € |
Commissions | 5% | 10% |
Total Price | 36,74 € | 38,49 € |
Payment buttons | Pay with Stripe |
Before buying read the Pricing notes!
Buying an addon includes proritary support via chat (1h/year) and proritary feature requests (1/year). The addon is valid only for one website (if you want to use this for multiple websites, you have to buy it again). Buying an addon multiple times will allow you to sum the addon features (for example, you buy 2 times an addon: you will be able to install the addon on two websites and you will get 2 hours/year of prioritary support via chat and 2 proritary feature requests/year)
If you want to cancel the subscription you can do it via your PayPal account if you paid with PayPal. Otherwise, check if there is an unsubscribe link in your stripe subscription confirmation email or contact the developer from his website (chat in the bottom-right corner or contact form)
If you have an SSO system located on a subdomain (for example account.example.com) and your Flarum installed on another subdomain (forum.example.com
) you must set the Root domain option to the root domain (example.com), not the subdomain (account.example.com). While this is possible, it’s not possible to get this extension working on two different domains (example.com, example2.com) due to cookies limitation (see here for more info)
Do these checks (in order):
maicol07/flarum-ext-sso
must be installed in FlarumCheck if there is the flarum_token
cookie in your Flarum cookies. If yes, then check the first step (if not already done) and proceed to the next step. If not, you probably have set something wrong in the plugin settings.
Check if your user credentials rules are compatible with Flarum ones. Detailed rules are listed in this issue: https://tracker.maicol07.it/issue/FSSOE-13
Flarum won’t login the user if the credentials don’t satisfy these rules. It is suggested to enforce these rules (or strictier ones) in WP with a dedicated plugin (not covered here).
If you’re trying to login to Flarum with an user that existed before enabling SSO, you have to use the same Flarum password in WP. Otherwise, passwords will mismatch and login fails.
Major changes are marked with
Breaking changes are marked with
Requires PHP 7.2+ and the JSON extension
#FSSOE-11