Skip to main content

Documentation: Access Key plugin

Configuration

Enabling this plugin logs you out of the site and requires the access key to log in to the administrator area. Make sure you always have a backup and use this plugin at your own risk.

The Access Key plugin has a small set of options that control how it works. Here's the full list, found under the Access Key System plugin settings.

Access Key plugin settings

Access Key The key you need to add to the login URL to reach the administrator area, for example OpenSesame. With that key set, log in at https://www.website.com/administrator?OpenSesame.
Whitelist IP Addresses IP addresses (separated by commas, e.g. 127.0.0.1, 127.0.0.2) that can reach the administrator area without the access key. Supports both exact IPs and CIDR ranges (e.g. 192.168.1.0/24).
Your IP Address Your current IP address, shown for convenience. Copy it into the field above to whitelist yourself.
Action on Failure What happens when no access key, or the wrong one, is provided: show a message or redirect the visitor.
Message (only visible when Action on Failure is set to Show Message) The message shown when the access key is missing or incorrect. The administrator login screen stays hidden from this visitor.
Redirect (only visible when Action on Failure is set to Redirect to URL) Where to send a visitor who doesn't provide the access key. Leave empty to redirect to the site's homepage.
Whitelist Message (applies to whitelisted IP addresses) An informational message shown to whitelisted visitors who reach the administrator area without entering the access key, confirming they were let in because their IP is on the whitelist.

accesskey settings 02