Retour for Kirby 插件安装与使用指南

Retour for Kirby 插件安装与使用指南

retour-for-kirbyKirby CMS plugin to manage redirects and track 404s right from the Panel项目地址:https://gitcode.com/gh_mirrors/re/retour-for-kirby

---

1. 目录结构及介绍

Retour for Kirby 是一个专为 Kirby 内容管理系统设计的插件，用于管理和追踪重定向及404错误。以下是该插件的基本目录结构概述：

site/
│  
└── plugins/                   # Kirby 的插件存放目录
    └── retour/               # Retour插件主目录
        ├── config.php         # 配置文件，设置插件的行为
        ├── composer.json      # 依赖管理文件（如果使用Composer安装）
        ├── index.php          # 主入口文件，可能用于初始化插件
        ├── lib/                # 包含插件主要逻辑的类库
        ├── templates/         # 包含自定义面板界面的模板文件
        ├── vendor/             # 第三方依赖（如果是通过Git克隆或下载zip包的话，这个目录可能是空的）
        ├── .gitignore         # Git忽略文件列表
        └── README.md          # 项目说明文档

• config.php：包含了插件的配置选项，允许用户自定义重定向规则等。
• index.php：通常负责插件的加载和初始化工作。
• lib/：存储了插件的核心代码，如处理重定向逻辑的类。
• templates/：含有管理界面的HTML模板。

---

2. 项目启动文件介绍

启动过程主要是通过Kirby的插件系统自动触发的，关键在于index.php文件。尽管直接操作此文件的情况较少，了解其作用仍很重要。在这个文件中，插件会注册自己到Kirby的事件循环中，比如监听页面加载或者面板初始化事件，进而执行初始化代码和设置钩子（hooks）来插入重定向管理和404追踪的功能。

在实际应用中，您不需要手动编辑index.php，而是遵循插件提供的安装步骤来启用功能。

---

3. 项目的配置文件介绍

config.php是您需要关注的主要配置文件。它允许您定制Retour插件的行为，例如添加重定向规则、设置HTTP状态码、以及是否开启404跟踪等。示例配置可能包含以下内容：

return [
    'status' => 301, // 默认重定向状态码
    'rules' => [       // 重定向规则数组
        ['from' => '/old-page', 'to' => '/new-page'],
    ],
    'track' => true,   // 是否追踪未找到的页面请求
    'logs' => [],       // 可以进一步配置日志存储细节
];

每一个规则都是一个数组，定义了一个从旧URL(from)到新URL(to)的映射。配置项允许高度定制以适应不同的网站需求。当您部署此插件时，可以通过Kirby的后台面板更直观地管理这些配置，而无需直接编辑此文件。

---

请注意，具体的配置项可能会随着插件版本更新而有所变化，建议参考最新的官方文档或插件仓库中的README.md文件获取最新信息。

retour-for-kirbyKirby CMS plugin to manage redirects and track 404s right from the Panel项目地址:https://gitcode.com/gh_mirrors/re/retour-for-kirby