README

Temporarily lock certain users out of the control panel.

Installation

Requirements

This plugin requires Craft CMS 4.0.0 or later.

Plugin Store

Log into your control panel and click on 'Plugin Store'. Search for 'Lockout'.

Composer

Open your terminal and go to your Craft project:

cd /path/to/project

Then tell Composer to load the plugin:

composer require jalendport/craft-lockout

In the Control Panel, go to Settings → Plugins and click the “Install” button for Lockout.

Using Lockout

When Lockout is enabled, any non-admin users will be effectively blocked from accessing the CP. Useful if you ever need to make some structural changes and want to prevent new content from being added to the production DB during that time.

Settings

To enable Lockout, simply toggle the lightswitch. It's that simple!

There is also a message setting where you can pass a custom message to the error screen your users will see when they are locked out.

Widget

In cases where you're using Project Config and allowAdminChanges is set to false you won't be able to enable/disable Lockout via the plugin settings. Instead you'll want to add the Lockout widget to your CP dashboard - it provides the same functionality as the lightswitch on the plugin settings page.

CLI

Lockout also provides two console commands for use in your deployment scripts:

./craft lockout/lockout/enable      // Restrict non-admin users from accessing the CP.

./craft lockout/lockout/disable     // Allow non-admin users to access the CP.

Found a Bug? Need Support?

Please open an issue describing what's going wrong.

Roadmap

Some things to do, and ideas for potential features:

Provide the ability to customize which users are locked out or whitelisted.

If there's a feature you think should be added to Lockout, please open an issue. PRs are also welcome!

Contributors

Plugin development: Jalen Davenport / @jalendport
Icon: Kiran Joseph from the Noun Project

jalendport / craft-lockout

Maintainers

Details