zilliz/attu

Attu

Attu是Milvus的一站式管理工具，通过图形化界面可显著降低Milvus向量数据库的管理成本，支持监控、数据操作、集合管理、向量搜索等核心功能。

安装指南

开始前，请确保已在Zilliz Cloud或自建服务器上安装Milvus。

兼容性说明

使用Docker运行Attu

以下是启动Attu容器的步骤：

bash
docker run -p 8000:3000 -e MILVUS_URL={milvus服务器IP}:19530 docker.xuanyuan.run/zilliz/attu:v2.4

确保Attu容器可访问Milvus服务器IP。启动后，在浏览器中输入http://{Attu服务器IP}:8000即可访问Attu图形界面。

Attu Docker可选环境变量

注意：MILVUS_URL必须是Attu容器可访问的地址，因此"127.0.0.1"或"localhost"无法正常工作。

Attu SSL配置示例

bash
docker run -p 8000:3000 \
-v /本地TLS文件路径:/app/tls \
-e ATTU_LOG_LEVEL=info  \
-e ROOT_CERT_PATH=/app/tls/ca.pem \
-e PRIVATE_KEY_PATH=/app/tls/client.key \
-e CERT_CHAIN_PATH=/app/tls/client.pem \
-e SERVER_NAME=your_server_name \
docker.xuanyuan.run/zilliz/attu:dev

自定义服务器端口示例

以下命令使用主机网络模式运行容器，并指定自定义服务器监听端口

bash
docker run --network host \
-v /本地TLS文件路径:/app/tls \
-e ATTU_LOG_LEVEL=info  \
-e SERVER_NAME=your_server_name \
-e SERVER_PORT=8080 \
docker.xuanyuan.run/zilliz/attu:dev

在Kubernetes中运行Attu

开始前，请确保K8s集群中已安装并运行Milvus（参考Milvus集群安装文档）。Attu仅支持Milvus 2.x版本。

部署步骤：

bash
kubectl apply -f https://raw.githubusercontent.com/zilliztech/attu/main/attu-k8s-deploy.yaml

确保Attu Pod可访问Milvus服务。示例配置中默认连接my-release-milvus:19530，需根据实际Milvus服务名称修改。更灵活的方式是使用ConfigMap，详见https://raw.githubusercontent.com/zilliztech/attu/main/examples/attu-k8s-deploy-ConfigMap.yaml。

安装桌面应用

如偏好桌面版，可下载https://github.com/zilliztech/attu/releases/。

本地构建Docker镜像

• 开发版：yarn run build:dev
• 发布版：yarn run build:release

常见问题

• 无法登录系统

  确保Milvus服务器IP可从Attu容器访问。https://github.com/zilliztech/attu/issues/161

• 待补充

更多截图

✨ 代码贡献

感谢您对Attu贡献的兴趣！以下是本地构建Attu以贡献代码、测试新功能或尝试开放PR的步骤：

构建服务器

1. Fork并克隆Attu仓库。
2. 终端中运行cd server进入服务器目录。
3. 运行yarn install安装依赖。
4. 开发模式启动服务器：yarn start。
5. 创建PR分支：git checkout -b my-branch。

构建客户端

1. Fork并克隆Attu仓库。
2. 终端中运行cd client进入客户端目录。
3. 运行yarn install安装依赖。
4. 开发模式启动客户端：yarn start。
5. 创建PR分支：git checkout -b my-branch。

提交Pull Request

1. 完成修改并确保测试通过。
2. 提交更改并推送到您的fork仓库。
3. 创建指向Attu主分支的Pull Request。

我们感谢您对Attu的任何贡献，无论大小。感谢支持本项目！

❓ 有问题或遇到困难？

如遇到bug或需请求新功能，请创建https://github.com/zilliztech/attu/issues/new/choose。提交前请先检查是否已有相同issue。

有用的链接

以下是Milvus相关资源，帮助您快速上手：

• Milvus文档：包含安装指南、教程和API文档的详细信息。
• https://github.com/milvus-io/pymilvus：Python开发工具包，提供创建和查询向量的简洁接口。
• https://github.com/milvus-io/milvus-sdk-java：Java开发工具包，功能与Python SDK类似。
• https://github.com/milvus-io/milvus-sdk-go：Go语言API，适用于Go开发者。
• https://github.com/milvus-io/milvus-sdk-node：Node.js API，适用于Node.js开发者。
• https://github.com/zilliztech/feder：JavaScript工具，用于帮助理解嵌入向量。

社区

💬 加入Milvus ***社区，分享知识、提问和参与讨论。不仅是代码交流，更是与志同道合者连接的平台！点击下方链接加入：