smartrent/exqui

EXQ UI Docker镜像文档

镜像概述和主要用途

本镜像为EXQ UI的容器化部署方案，EXQ是Elixir生态中常用的后台作业处理库，而EXQ UI则是其配套的Web管理界面。该镜像旨在提供便捷的部署方式，帮助开发者和运维人员通过直观的Web界面监控、管理Elixir应用中的后台作业，包括作业队列状态、任务执行详情、历史记录等关键信息，提升后台任务管理效率。

核心功能和特性

• 实时监控作业队列：实时展示各作业队列的待处理任务数、处理中任务数及失败任务数
• 任务详情查看：支持查看单个任务的状态（待处理/处理中/成功/失败）、执行时间、错误信息（若失败）等详细属性
• 任务管理操作：提供任务重试、取消等基础管理功能，快速处理异常任务
• 历史记录查询：支持按时间范围、任务状态等条件查询历史任务记录，便于问题追溯
• 直观Web界面：基于Web的图形化界面，操作简单，无需命令行交互即可完成核心管理操作

使用场景和适用范围

适用场景

• 基于Elixir开发的Web应用，使用EXQ处理异步任务（如订单处理、邮件发送、数据导出等）
• 需要对后台作业进行可视化监控的场景，降低人工巡检成本
• 需快速定位和处理失败任务的生产环境，减少故障恢复时间

适用范围

• 技术栈：Elixir + EXQ的应用系统
• 部署环境：支持Docker的服务器或容器平台（如Kubernetes、Docker Compose）
• 用户角色：开发人员、运维人员、需要监控后台任务状态的业务人员

使用方法和配置说明

环境变量配置

Docker Run部署示例

bash
docker run -d \
  --name exq-ui \
  -p 4040:4040 \
  -e EXQ_REDIS_HOST=redis-server \  # 替换为实际Redis主机地址
  -e EXQ_REDIS_PORT=6379 \
  -e EXQ_REDIS_PASSWORD=your-redis-password \  # 若Redis启用密码认证
  -e EXQ_NAMESPACE=my_app_exq \  # 若EXQ使用自定义命名空间
  exq-ui:latest

Docker Compose部署示例

yaml
version: '3.8'

services:
  exq-ui:
    image: exq-ui:latest
    container_name: exq-ui
    ports:
      - "4040:4040"
    environment:
      - EXQ_REDIS_HOST=redis
      - EXQ_REDIS_PORT=6379
      - EXQ_REDIS_DATABASE=1  # 假设EXQ作业数据存储在Redis DB 1
      - PORT=4040
    depends_on:
      - redis  # 依赖Redis服务（若Redis与EXQ UI部署在同一网络）
    restart: unless-stopped

  redis:
    image: redis:alpine
    container_name: exq-redis
    ports:
      - "6379:6379"
    volumes:
      - redis-data:/data  # 持久化Redis数据
    restart: unless-stopped

volumes:
  redis-data:

访问方式

容器启动后，通过 http://<宿主机IP>:4040 访问EXQ UI界面，无需额外认证（默认配置下），即可查看和管理后台作业。

注意事项

• 确保EXQ UI与EXQ服务使用相同的Redis配置（主机、端口、数据库、命名空间），否则可能无法正确读取作业数据
• 生产环境中建议为Redis配置密码认证，并通过EXQ_REDIS_PASSWORD环境变量传入
• 若部署在公网环境，建议结合反向代理（如Nginx）配置访问控制（如IP白名单、Basic Auth），提升安全性