utfcube / buddy-plugin-update-text

Buddy UPDATE 全文字段处理器插件

dev-main 2023-06-02 07:24 UTC

This package is auto-updated.

Last update: 2024-10-01 00:22:52 UTC


README

这是一个 Buddy 插件的初始模板,您可以用它来开发。

如何开始

  1. 从模板创建一个仓库。
  2. 打开 composer.json 并使用您的插件名称、依赖项和其他所需内容编辑它。
  3. 运行 composer install 使其生效。
  4. 您需要使用我们官方的 manticore-executor;我们强烈建议使用 Docker 流。
  5. 编辑 src/Payload.php,添加解析请求的逻辑,并为您的命令处理准备有效负载结构。
  6. 编辑 src/Handler.php 并实现 Manticore 将代理到客户端的处理逻辑和响应。

如何使用 manticore-executor-dev 的 Docker

  1. Buddy 克隆到您的宿主机上的某个位置,并进入该目录。

  2. 运行此命令以创建名为 manticore-buddy 的 Docker 镜像

    docker run --privileged --entrypoint bash -v $(pwd):/workdir -w /workdir --name manticore-buddy  --network host -it manticoresearch/manticore-executor-kit:latest
  3. 现在您可以编辑 /etc/manticore.conf 并配置 Buddy 的开发版本

    buddy_path = manticore-executor-dev /workdir/src/main.php --debug
    
  4. 运行 searchd --nodetach 以使守护进程在前台运行,并享受您新插件的开发。

注意事项

您可以使用 pre-commit 通过运行 pre-commit install 安装代码风格和代码分析钩子。请检查我们的 PHP 代码风格和指南 此处