包简介

Kirby Password Guard

README 文档

README

Kirby Password Guard is a simple password protection for your Kirby 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:

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:

<!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.

pechente/kirby-password-guard 适用场景与选型建议

pechente/kirby-password-guard 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 5.86k 次下载、GitHub Stars 达 37，最近一次更新时间为 2024 年 10 月 25 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「password」「development」「panel」「protect」「guard」「kirby5」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 pechente/kirby-password-guard 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 pechente/kirby-password-guard 我们能提供哪些服务？

定制开发 / 二次开发

基于 pechente/kirby-password-guard 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 pechente/kirby-password-guard 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

bpocallaghan/impersonate 8

Debugging a problem and need to login as one of your customers? This allows you to authenticate as any of your customers.

darkv/php-password-generator 4

The PHP class PasswordGenerator serves as a password generator to create memorable passwords like the keychain of macOS ≤ 10.14 did.

fsc/batch 18

Library with classes to help you do batch.

divineomega/laravel-route-restrictor 4

Laravel middleware to restrict a site or specific routes using HTTP basic authentication

kak/panel 0

Yii2 panel widget

maatify/crypto 1

High-level cryptographic primitives and security utilities for Maatify systems including password hashing, reversible encryption, HKDF key derivation, and key rotation.

pechente/kirby-password-guard

包简介

关键字：