Integrate ChatWee SSO with Flarum
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
js
locale
migrations
src
.editorconfig
.gitattributes
.gitignore
LICENSE.md
README.md
bootstrap.php
composer.json

README.md

ChatWee Flarum SSO

MIT license Latest Stable Version Total Downloads Donate

Integrate ChatWee SSO with your Flarum. Features:

  • Automatically create accounts and connect users into ChatWee via SSO
  • Login into ChatWee can be restricted to a list of Flarum groups
  • Choose which Flarum groups get admin access in ChatWee
  • Username, avatar and admin status are automatically synced every time the Flarum user is edited
  • Integrates with Flarum account activation and suspension. Only activated and non-suspended users are logged into ChatWee
  • If an admin change the password of a user or suspend its account, he is disconnected from all existing ChatWee sessions
  • If the Flarum account was created before it being allowed to access ChatWee or if cookies expired/were deleted, a banner and button will allow the user to reconnect to ChatWee without having to reload the page

Please note: The Single Sign-on feature of ChatWee requires a ChatWee Pro account or higher.

Installation

Use Bazaar or install manually:

composer require clarkwinkelmann/flarum-ext-chatwee

Updating

composer update clarkwinkelmann/flarum-ext-chatwee
php flarum migrate
php flarum cache:clear

Configuration

Upon activation, the settings modal of the extension should appear. If not, you can access it by going to Admin > Extensions and Clicking on Settings on the ChatWee extension icon.

The following settings need to be configured:

Chat ID (required): The chatId attribute you can find in your ChatWee account.

Client Key (required): The clientKey attribute you can find in your ChatWee account.

Cookie Domain (recommended): This should be the same domain as the one used by the ChatWee javascript client. While not properly documented, it seems to be the second-level domain of your hostname. If your forum is hosted at forum.example.com, use example.com here.

Enable when logged out: Enabling this option will run the ChatWee javascript client even if no user is logged into Flarum. This can be useful to also enable guest access or another login provider inside ChatWee. This does not enable guest access inside your ChatWee account.

The following permissions can be configured in the Admin > Permissions area:

Auto-login via SSO: Which Flarum users will be able to access ChatWee. Set this option to Members to allow all enabled and non-suspended accounts to access it. Please note that if you narrow down this setting while users are connected, this will not automatically disconnect any user who lost the privilege. Their sessions will remain valid until they log out or are suspended.

ChatWee Admin access: Which Flarum users will get the admin flag (isAdmin) applied to their ChatWee SSO account. Changing this setting will not automatically update the user status. Users need to update their profile (username, avatar or group) to refresh the ChatWee account role (whether it was gained or lost).

Acknowledgements

The original version of this extension was created for Coinpedi.

Links

This is an extension by Clark Winkelmann. Need a custom Flarum extension ? Contact me !