91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
|
# Kirby Password Guard
|
||
|
|
|
||
|
|
**Kirby Password Guard** is a simple password protection for your [Kirby](https://getkirby.com/) website. It allows you
|
||
|
|
to
|
||
|
|
set a password that needs to be entered in order to access the site. This can be useful for staging sites to prevent
|
||
|
|
unwanted access. Logged in users can access the site normally but any guest will run into the password entry page.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
****
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
### Download
|
||
|
|
|
||
|
|
Download and copy this repository to `/site/plugins/kirby-password-guard`.
|
||
|
|
|
||
|
|
### Git submodule
|
||
|
|
|
||
|
|
```
|
||
|
|
git submodule add https://github.com/pechente/kirby-password-guard.git site/plugins/kirby-password-guard
|
||
|
|
```
|
||
|
|
|
||
|
|
### Composer
|
||
|
|
|
||
|
|
```
|
||
|
|
composer require pechente/kirby-password-guard
|
||
|
|
```
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
### Configuration
|
||
|
|
|
||
|
|
Add the following lines to your config.php:
|
||
|
|
|
||
|
|
```php
|
||
|
|
return [
|
||
|
|
'pechente.kirby-password-guard' => [
|
||
|
|
'enabled' => true, // Optional - default is true
|
||
|
|
'password' => 'password', // Required - The password used to access the site. If left empty the plugin will not be enabled.
|
||
|
|
'pattern' => '(:all)', // Optional - The pattern to protect. By default, all pages are protected. Check the Kirby documentation for more information.
|
||
|
|
]
|
||
|
|
];
|
||
|
|
```
|
||
|
|
|
||
|
|
### Template
|
||
|
|
|
||
|
|
You can overwrite the template for the password form by creating the file `site/templates/password-guard.php`. Here's a
|
||
|
|
minimal example of what this file needs to include:
|
||
|
|
|
||
|
|
```php
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<title><?= $page->title() ?></title>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<form method="post" action="<?= $page->url() ?>">
|
||
|
|
<label for="password">Password:</label>
|
||
|
|
<input type="password" name="password" id="password" required>
|
||
|
|
<input type="hidden" name="redirect" value="<?= $page->redirect() ?>">
|
||
|
|
<button type="submit">Submit</button>
|
||
|
|
<?php if ($page->passwordIncorrect()->toBool()): ?>
|
||
|
|
<div class="info">Wrong Password</div>
|
||
|
|
<?php endif ?>
|
||
|
|
</form>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
```
|
||
|
|
|
||
|
|
Please keep in mind that you should avoid adding code from your website like the stylesheets or header / footer since it
|
||
|
|
might defeat the purpose of the password protection.
|
||
|
|
|
||
|
|
## FAQ & Troubleshooting
|
||
|
|
|
||
|
|
### I'm not seeing the password prompt when I visit my site
|
||
|
|
|
||
|
|
Make sure you're not signed in. If you're signed in, you won't see the password prompt. I'd recommend testing the plugin
|
||
|
|
in a private browsing window.
|
||
|
|
|
||
|
|
If that didn't work, make sure that the configuration is correct.
|
||
|
|
|
||
|
|
### How secure is the password protection?
|
||
|
|
|
||
|
|
The password is verified on the backend and cannot easily be circumvented. The password is only ever stored as a hash on
|
||
|
|
the user's side.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
If you have any issues with the plugin, please open an issue here on GitHub.
|