--- title: "Access Key plugin" --- # Access Key plugin ## Install the plugin When you enable this plugin, you will be logged out of your website and you need to use the Access Key to login to the administrator.  Make sure you always have a backup and use this plugin at your own risk. Before installation please check that the below system requirements are met. You can ask your webhoster if the server you are working on supports them. You can also find the information in the Joomla! backend under System > System information. ## General requirements - Joomla! 4.x or 5.x ## Preparations - Create a full backup of the website. You can use [Akeeba Backup](http://www.akeeba.com) to create a quick one - Upgrade to the latest version of Joomla! ## Installation (upload & install) The installation of our extensions is done with the Joomla! installer. Anyone that is already using Joomla! shouldn't have any problem, for those that are somewhat new in Joomla! we'll explain the steps required to make the installation of the extensions in your website. 1) After downloading the installation file from our website, go to your Joomla! administration and go to **System > Install > Extensions** ![install 01](https://joomill-templates.com/images/documentation/general/install-01.jpg) 2) Then select the file in the tab **Upload Package File**, after a few moments you'll get a message saying the extension is installed. ![install 02](https://joomill-templates.com/images/documentation/general/install-02.jpg) 3) The plugin will be published automaticly. Go to **Extensions** » **Extension Manager,**find the Access Key plugin (System - ) and see if the plugin to **Published**to check this. Now you're ready to start using our extension!   [Lees meer...](https://joomill-templates.com/access-key-plugin/install-the-plugin.md) ## Configuration When you enable this plugin, you will be logged out of your website and you need to use the Access Key to login to the administrator.  Make sure you always have a backup and use this plugin at your own risk. The Access key plugin is packed with options, giving you control over how it works and behaves. Here is the full list of the options you can find in the **Access Key System plugin settings**. ![accesskey settings](https://joomill-templates.com/images/documentation/accesskey/accesskey-settings.png) | | | | --- | --- | | Access Key | Enter the Access Key you want to use. The only way you will be able to log in to the administrator is by typing administrator followed by question mark and then the Access Key. For example enter **OpenSesame** Next time you would like to login you need to enter: https://www.website.com/administrator?OpenSesame | | Whitelist IP Addresses | These IP Addresses (separated by comma e.g. 127.0.0.1 , 127.0.0.2) don't need to use the Access Key to enter the Joomla backend. | | Your IP Address | Here you can see your current IP Address, Just copy and paste it to the field above when you would like to Whitelist this Address. | | Action on Failure | Choose an action when No or a Wrong Access Key is used. | | Message *(only visible when Action on Failure is set to Show Message)* | This message is displayed if the Access Key is not provided. The administrator login screen is not available for this visitor. | | Redirect *(only visible when Action on Failure is set to Show Message)* | URL where a user is redirected to when no Access Key is provided. Leave empty to redirect to the Joomla Root / Frontend. | ![accesskey settings 02](https://joomill-templates.com/images/documentation/accesskey/accesskey-settings-02.png)   [Lees meer...](https://joomill-templates.com/access-key-plugin/configuration.md) ## HELP! I forgot my Access Key Sometimes you can't remember your access key and you are locked out of your Joomla Backend. No worries! Just follow one of these steps. **a) Do you have access to the FTP?** Go to the folder "ROOT" > Plugins > System and rename the folder: accesskey to something else like --accesskey. Now you can enter the backend of your website without any access key. (like: [https://www.website.com/administrator](https://www.website.com/administrator)) After you logged in go to System > Manage > Extensions, find the Access Key plugin and uninstall the plugin. Go to System > Install > Extensions and install it again. **b) Or do you have access to the database?** You can disable the Access Key plugin by using this SQL Query: `UPDATE #__extensions SET enabled = "0" WHERE name = "PLG_SYSTEM_ACCESSKEY"` (change #__extensions to the database prefix you use on your website, like abc_extensions ) When the plugin is disabled you can enter the backend of your website without any access key (like: [https://www.website.com/administrator](https://www.website.com/administrator)) Go to System > Plugins > Access Key Plugin and choose a new Access Key Enable the plugin again. [Lees meer...](https://joomill-templates.com/access-key-plugin/help-i-forgot-my-access-key.md) ## Changelog [changelog-accesskey] [Lees meer...](https://joomill-templates.com/access-key-plugin/changelog.md)