madmatt / silverstripe-elastic-proxy
一个简单的代理模块,以确保您的 Elastic API 密钥不会泄露。
1.0.0
2020-09-29 04:04 UTC
Requires
- silverstripe/framework: ^4.0
Requires (Dev)
- phpunit/phpunit: ^5.7
- squizlabs/php_codesniffer: ^3.0
This package is auto-updated.
Last update: 2024-09-21 09:10:13 UTC
README
一个搜索代理系统,通过 SilverStripe 主机端点代理所有搜索查询,以确保您的 API 密钥、端点 URL 等不会暴露给公众。
此系统旨在与 elastic/search-ui React 库 一起使用。它允许您使用 React 驱动的前端的所有功能和灵活性,同时确保您的 API 凭据和端点保持隐藏。
此概念简单到足以方便地移植到其他框架。
要求
- SilverStripe
^4
- Elastic App Search、Elastic Enterprise Search 或类似产品(无论是自托管还是 Elastic Cloud)
许可证
见 许可证
安装
composer require madmatt/silverstripe-elastic-proxy
配置
此模块在配置之前不会做任何事情。请参阅 docs/configuration.md。
升级
当模块的新版本发布时,您需要手动重新运行 配置步骤 - 没有什么会自动为您更新。
故障排除
如果您在此模块有问题,首先尝试撤销 配置文档 中所做的 JS 更改,以确保您直接连接到 Elastic 时操作正常。如果正常,但使用 endpointBase
的 /_search
时不起作用,则可能存在模块的 bug - 请 创建 GitHub 问题 并尽可能提供详细信息。
维护者
错误追踪器
错误在此存储库的问题部分跟踪。在提交问题之前,请先阅读现有问题,以确保您的问题独特。
如果问题看起来像是一个新错误
- 创建新问题
- 描述重现您问题的步骤和预期结果。单元测试、屏幕截图和屏幕录制可以帮助这里。
- 尽可能详细地描述您的环境:Silverstripe CMS 版本、浏览器(如果相关)、PHP 版本、操作系统、安装的任何 Silverstripe 模块。
请直接向模块维护者报告安全问题。请勿在错误跟踪器中提交安全问题。
开发和贡献
如果您想为此模块做出贡献,请确保您提交了拉取请求并与模块维护者讨论。有关更多详细信息,请参阅 贡献文档。