manticoresoftware/buddy-plugin-show

此包已被废弃,不再维护。未建议替代包。

Buddy SHOW 插件

v0.1.0 2023-10-18 07:40 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 image: ghcr.io/manticoresoftware/manticoresearch:test-kit-latest:latest
  3. 现在您可以编辑 /etc/manticore.conf 并配置 Buddy 的开发版本

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

注意

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