superbig/craft3-autologin

Automatically login based on whitelisted IP, basic auth username or URL keys

Autologin plugin for Craft CMS

Automatically login based on whitelisted IP, basic auth username or URL keys., _(*1)

Installation

You can install Autologin via the plugin store, or through Composer., _(*2)

Craft Plugin Store

To install Autologin, navigate to the Plugin Store section of your Craft control panel, search for Autologin, and click the Try button., _(*3)

Composer

You can also add the package to your project using Composer., _(*4)

1. Open your terminal and go to your Craft project:, _(*5)

   cd /path/to/project

2. Then tell Composer to load the plugin:, _(*6)

   composer require verbb/autologin

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Autologin., _(*7)

Configuring Autologin

The plugin is configured in the config/ directory in a file you create called autologin.php. What follows is an example of what it might contain., _(*8)

<?php
return [
    // Enable the Autologin plugin
    'enabled' => true,

    // A list of Craft usernames/emails mapped to IPs
    'ipWhitelist' => [
        'craftUsername' => [
            '162.247.141.58',
            '162.247.141.59',
        ],
    ],

    // A list of Craft usernames/emails mapped to basic auth usernames
    'basicAuth' => [
        'craftUserName1' => 'basicAuthUsername',
        'craftUserName2' => 'basicAuthUsername2',    
    ],

    // A list of Craft usernames/emails mapped to url keys
    'urlKeys' => [
        'craftUserName' => 'BepmD8GQBZpaFpXQ',
    ],

    // Redirect to this url after logging in automatically
    'redirectUrl' => '',
];

Login by URL

You can provide your users with a url that automatically logs them in. To set this up, you need a pair of username => password in the urlKeys setting., _(*9)

After setting that up, you can login by going to siteurl.tld/autologin?key=BepmD8GQBZpaFpXQ., _(*10)

If you want to redirect to the control panel dashboard, add cp=true to the url: siteurl.tld/autologin?key=BepmD8GQBZpaFpXQ&cp=true, _(*11)

Credits

Originally created by the team at Superbig., _(*12)

Show your Support

Autologin is licensed under the MIT license, meaning it will always be free and open source – we love free stuff! If you'd like to show your support to the plugin regardless, Sponsor development., _(*13)

, _(*14)