README

PHPTypesenseAdmin是一个简单的管理面板，旨在与Typesense交互，Typesense是一个开源的、容错的搜索引擎，为您的应用程序提供即时搜索体验。该项目旨在提供一个易于使用的界面来管理您的Typesense实例，包括查看集合、文档和管理API密钥等功能。

屏幕截图

登录界面

仪表板

集合概述

功能

健康状态
集合
- 列出集合
- 创建集合
- 更新集合
- 删除集合
- 创建/导入集合的curl提示
API密钥
- 列出密钥
- 删除密钥
- 创建密钥

安装

要开始使用PHPTypesenseAdmin，请按照以下步骤操作

步骤1. 选项A：Composer create-project

最简单的方法是运行composer create-project

composer create-project devproblemssolutions/phptypesenseadmin example-app

步骤1. 选项B：克隆仓库

首先，将此仓库克隆到您的本地机器或服务器。您可以通过运行以下命令来实现

git clone https://github.com/devproblemssolutions/PHPTypesenseAdmin.git
cd PHPTypesenseAdmin

在新建目录下运行

composer install

2. 配置

在您的项目根目录下创建一个env.php文件。您可以这样做，将提供的env.example.php复制到env.php或创建一个新的env.php文件

cp env.example.php env.php

或

touch env.php

然后，打开env.php并更新相应的配置变量

<?php
$correctUsername = 'admin'; // CHANGE
$correctPassword = 'password'; // CHANGE

$typesenseProtocol = 'https'; // CHANGE
$typesenseApiKey = 'YOURAPIKEY'; // CHANGE
$typesenseHost = 'HOST'; // CHANGE
$typesensePort = 443; // CHANGE

请确保将占位符值替换为您的实际Typesense服务器详细信息以及所需的管理员登录凭证。

3. 安装依赖项

运行以下命令通过Composer安装必要的PHP依赖项

composer install

4. 服务器配置

出于安全考虑，请确保只有public目录可被网络流量访问。如果部署到实时服务器，请考虑在本地运行此面板或配置它以便仅在IP防火墙后面访问。

重要：PHPTypesenseAdmin处于早期开发阶段。可能仍存在错误和潜在的安全漏洞。请考虑这一点，并避免在生产环境中运行此软件。

使用

完成安装步骤后，您可以通过在浏览器中导航到您的公共目录来开始使用PHPTypesenseAdmin。使用您在env.php中指定的凭证登录以管理您的Typesense实例。

贡献

欢迎贡献、问题和技术需求。如果您想贡献，请随时检查问题页面。

免责声明

使用本软件的风险自负。虽然已经尽力确保安全性和稳定性，但仍可能存在未检测到的错误或漏洞。作者或贡献者不对由此造成的任何损坏或数据丢失负责。

devproblemssolutions / phptypesenseadmin

维护者

详细信息