---
title: Summary
url: 'https://manuals.remository.com/flarum/read-me'
markdown: 'https://manuals.remository.com/flarum/read-me.md'
date: '2026-10-06'
description: 'Version: 1.3.0 Author: Martin Brampton License: GNU/GPL Email: martin@remository.com URL: https://remository.com A comprehensive Joomla 5 plugin that provides seamless Single Sign-On (SSO) integration between Joomla and Flarum using JWT-based authentication. Features ✅ Single Sign-On (SSO) - Autom…'
taxonomy:
  category:
    - docs
---

[](#) [ edit this page](https://github.com/getgrav/grav-skeleton-rtfm-site/blob/develop/pages/05.read-me/docs.md) 

# Summary

*Version*: 1.3.0
*Author*: Martin Brampton
*License*: GNU/GPL
*Email*: <martin@remository.com>
*URL*: <https://remository.com>

A comprehensive Joomla 5 plugin that provides seamless Single Sign-On (SSO) integration between Joomla and Flarum using JWT-based authentication.

## Features

✅ *Single Sign-On (SSO)* - Automatic login to Flarum when logged into Joomla
✅ *Menu-Based Forum Access* - Direct forum links with automatic authentication
✅ *User Synchronization* - Automatic user creation, updates, and deletion
✅ *Group Management* - Joomla user groups mapped to Flarum groups
✅ *JWT Authentication* - Secure token-based authentication using lcobucci/jwt
✅ *Cross-Domain Support* - Works with subdomains (e.g., forum.yoursite.com)
✅ *API-First Approach* - Uses Flarum API with minimal database access

## Requirements

### Joomla Requirements

1. Joomla 5.x
2. PHP 8.2+
3. OpenSSL extension
4. Sodium extension

### Flarum Requirements

1. Flarum 1.8+
2. maicol07/flarum-ext-sso extension
3. lcobucci/clock library (automatically installed)

## Quick Start

⚠️ *IMPORTANT**: Before starting, ensure your Flarum admin user has the** same email address* as your Joomla admin user. See [Flarum Setup Guide](joomlaflarum:flarumsetup) for details.

1. *Install the plugin* in Joomla (plugins/user/flarum/)
2. *Configure Flarum SSO* - See [Flarum Setup Guide](https://manuals.remository.com/flarum/setup)
3. *Enable the plugin* in Joomla Extensions → Plugins
4. *Configure settings* - Flarum URL, API key, JWT settings
5. *Create menu link* - Use the forum redirect URL in your menu

### Menu Link URL

```
https://yoursite.com/index.php?option=com_ajax&plugin=flarum&group=user&method=forumRedirect&format=raw
```

## Documentation

1. [Flarum Setup Guide](https://manuals.remository.com/flarum/setup) - Complete Flarum installation and configuration
2. [Usage Examples](https://manuals.remository.com/flarum/usage) - Common usage scenarios and API examples
3. [Development Guide](https://manuals.remository.com/flarum/single-sign-on) - Development instructions and architecture

## Architecture

1. *Standard Joomla Plugin* - Follows Joomla 5 best practices
2. *JWT Authentication* - Secure token-based SSO with maicol07/flarum-ext-sso
3. *API-First* - Minimal database access, prefers Flarum API
4. *Dependency Injection* - Uses Joomla DI container with provider.php
5. *PSR-4 Autoloading* - Namespace: BlackSheepResearch\\Plugin\\User\\Flarum

## Support

This plugin integrates with the mature maicol07/flarum-ext-sso extension, providing enterprise-grade Single Sign-On between Joomla and Flarum.

For issues or questions, please check the documentation files or contact the author.

 [ ](https://manuals.remository.com/flarum/usage)

---

## Navigation

- Previous: [Usage](https://manuals.remository.com/flarum/usage.md)