bfritscher/typesense-dashboard

Typesense Dashboard Docker镜像文档

概述

Typesense Dashboard是一个针对Typesense搜索引擎的Web管理工具，提供直观的用户界面用于简化Typesense集合管理、文档浏览、模式配置和查询测试等操作。该Docker镜像封装了完整的Web应用，可快速部署并连接到本地或远程Typesense实例。

核心功能与特性

• 集合管理：创建、查看、编辑和删除Typesense集合
• 文档操作：浏览、搜索、筛选和查看集合中的文档数据
• 模式管理：查看和修改集合的字段模式定义
• 查询测试：直接在界面中构建和测试搜索查询，实时查看结果
• 简易连接：通过环境变量快速配置与Typesense服务的连接
• 轻量UI：简洁直观的Web界面，降低操作复杂度

使用场景与适用范围

• 开发环境：本地或开发服务器中管理Typesense实例
• 数据调试：开发和测试阶段验证数据结构和搜索功能
• 内容管理：非技术人员浏览和查看Typesense存储的数据
• 教学演示：展示Typesense搜索引擎的数据集和查询效果

快速开始

Docker Run 部署

bash
docker run -d \
  -p 8080:80 \
  -e TYPESENSE_URL=http://your-typesense-instance:8108 \
  -e TYPESENSE_API_KEY=your-typesense-api-key \
  --name typesense-dashboard \
  docker.xuanyuan.run/bfritscher/typesense-dashboard

启动后访问 http://localhost:8080 即可打开仪表板界面。

Docker Compose 示例

yaml
version: '3'
services:
  typesense:
    image: docker.xuanyuan.run/typesense/typesense:latest
    environment:
      - TYPESENSE_API_KEY=your-secret-key
      - TYPESENSE_DATA_DIR=/data
    volumes:
      - typesense-data:/data
    ports:
      - "8108:8108"

  dashboard:
    image: docker.xuanyuan.run/bfritscher/typesense-dashboard
    environment:
      - TYPESENSE_URL=http://typesense:8108
      - TYPESENSE_API_KEY=your-secret-key
    ports:
      - "8080:80"
    depends_on:
      - typesense

volumes:
  typesense-data:

配置参数

环境变量

端口映射

容器默认暴露80端口，建议映射到主机的非特权端口（如8080）以避免权限冲突。

使用方法

1. 连接Typesense实例：通过TYPESENSE_URL和TYPESENSE_API_KEY环境变量配置连接信息
2. 访问仪表板界面：启动容器后，通过http://<主机IP>:<映射端口>访问Web界面
3. 管理集合：在"Collections"页面进行集合的创建、编辑和删除操作
4. 浏览文档：选择集合后，在"Documents"页面查看、搜索和筛选文档
5. 测试查询：使用"Query Tester"功能输入搜索参数，验证查询结果

注意：该仪表板不支持修改Typesense服务的全局配置，仅针对集合和文档级别操作。