README

A Flarum extension that restricts sign-ups to user's who have a code created in the admin panel.

Each code can be set to have a maximum number of uses, what group the user should be automatically added to on sign up, and whether or not the user should be automatically activated.

Usage

• Setup sign-up codes on the admin panel
• Includes optional support for Direct Links. When this extension is also enabled, email invites will include a link which will take the uew user directly to the signup modal, rather than the forum home page.

OAuth Bypass

Important: this feature requires 1.7.1 or higher of fof/oauth.

Doorman can be configured to allow users registering through specific OAuth providers to bypass the doorkey requirement. This is useful for allowing trusted authentication methods (like corporate SSO) to skip the invitation code step.

To enable this feature in your extension:

use FoF\Doorman\Extend\BypassDoorkey;

// In your extend.php file
return [
    // ... other extenders
    
    (new BypassDoorkey())
        ->forProvider('github')    // Allow GitHub OAuth users to bypass doorkey
        ->forProvider('discord'),  // Allow Discord OAuth users to bypass doorkey
];

Installation

Install with composer:

composer require fof/doorman:"*"

Then login and enable the extension.

To Do

• Allow already signed up users to create codes for others to use (referrals)

Issues

• Open an issue on Github

Links

• On Github
• On Packagist