gnaudio/jabra-xpress-api

Jabra Xpress Web API 镜像文档

镜像概述和主要用途

Jabra Xpress是专为IT专业人员设计的软件解决方案，用于通过智能工具远程管理Jabra产品。本镜像（jabra-xpress-api）是Jabra Xpress自托管部署的核心Web API组件，提供设备管理、数据交互和系统集成接口，需与其他Jabra Xpress镜像及数据库配合使用，实现完整的远程设备管理功能。

完整Jabra Xpress部署架构

核心组件

完整部署需包含以下Docker镜像：

• https://hub.docker.com/r/gnaudio/fds.api
• https://hub.docker.com/r/gnaudio/jabra-xpress-analytics%EF%BC%88%E6%95%B0%E6%8D%AE%E5%88%86%E6%9E%90%E6%9C%8D%E5%8A%A1%EF%BC%89
• https://hub.docker.com/r/gnaudio/jabra-xpress-assets%EF%BC%88%E8%B5%84%E6%BA%90%E6%9C%8D%E5%8A%A1%EF%BC%89
• https://hub.docker.com/r/gnaudio/jabra-xpress-analytics-cron%EF%BC%88%E6%95%B0%E6%8D%AE%E5%88%86%E6%9E%90%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1%EF%BC%89
• https://hub.docker.com/r/gnaudio/jabra-xpress-api%EF%BC%88%E6%9C%ACAPI%E6%9C%8D%E5%8A%A1%EF%BC%89
• https://hub.docker.com/r/gnaudio/jabra-xpress-frontend%EF%BC%88%E5%89%8D%E7%AB%AF%E7%95%8C%E9%9D%A2%EF%BC%89

数据库要求

• MongoDB
• SQL数据库（Microsoft SQL Server 2017+或Azure SQL Database）

版本兼容性

建议所有镜像使用相同版本以确保兼容性。不同版本混合使用可能导致功能异常，例外情况：fds.api和jabra-xpress-assets有独立版本控制。

可选服务

部分功能需额外部署以下镜像，未部署则对应功能禁用：

• https://hub.docker.com/r/gnaudio/jabra-xpress-cron-compliancereporter%EF%BC%88%E5%90%88%E8%A7%84%E6%8A%A5%E5%91%8A%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1%EF%BC%89

资源依赖

• 请始终检查镜像页面获取最新可用标签。此处版本已确认兼容，如需特定功能可使用更新版本。
  ** 使用latest标签时需确认容器已正确更新，部分环境可能存在自动更新问题。

最新版本信息

v5.7.02901（2025年2月）

发布说明：Jabra Xpress 发布说明

重大变更

• 默认端口从80变更为8080，需配置ASPNETCORE_URLS环境变量（详见服务设置）。

服务配置参数

部署示例

使用docker-compose部署

yaml
backend:
  image: gnaudio/jabra-xpress-api:v5.7.02901
  environment:
    - "ConnectionStrings:XpressDatabaseSqlServer=SQL连接字符串"
    - "ConnectionStrings:MongoDb=MongoDB连接字符串"
    - "DefaultAnalyticsEndpoint=http://localhost:88/api/v1/analytics"
    - "JDODownload=http://localhost:89/"
    - "NetworkEndpoint=http://localhost:85"
    - "SDK:fwURL_base=http://localhost:82"
    - "SDK:fsURL_base=http://localhost:82"
    - "Security:PackageTokens:IssuerKey=9716702363504e4aaf47fa5bb2ec5c42"
    - "Security:ClientTokens:IssuerKey=ea99bbe6471848848b138ecb99e52d1f"
    - "Security:TokenProtection:Key=qt59#1dlZgsw3Tjv8eWyoQm$ib4u*O7N_"
    - "ASPNETCORE_URLS=http://+:8080"
  ports:
    - "85:8080"

使用docker run部署

bash
docker run -p 85:8080 -d \
  --env ConnectionStrings:XpressDatabaseSqlServer="SQL连接字符串" \
  --env ConnectionStrings:MongoDb="MongoDB连接字符串" \
  --env DefaultAnalyticsEndpoint="http://localhost:88/api/v1/analytics" \
  --env JDODownload="http://localhost:89/" \
  --env NetworkEndpoint="http://localhost:85" \
  --env SDK:fwURL_base="http://localhost:82" \
  --env SDK:fsURL_base="http://localhost:82" \
  --env Security:PackageTokens:IssuerKey="9716702363504e4aaf47fa5bb2ec5c42" \
  --env Security:ClientTokens:IssuerKey="ea99bbe6471848848b138ecb99e52d1f" \
  --env Security:TokenProtection:Key="qt59#1dlZgsw3Tjv8eWyoQm$ib4u*O7N_" \
  --env ASPNETCORE_URLS=http://+:8080 \
  gnaudio/jabra-xpress-api:v5.7.02901

SSL配置详见前端镜像文档：https://hub.docker.com/repository/docker/gnaudio/jabra-xpress-frontend/general

完整部署前置要求

系统要求

• 数据库：空的Microsoft SQL Server 2017+或Azure SQL Database；MongoDB实例
• Docker环境：Linux Docker主机（测试环境可使用Windows/macOS Docker CE）
• 资源：16GB RAM，建议4核CPU

部署注意事项

• 所有Jabra Xpress镜像需使用相同版本（fds.api和assets除外）
• https://hub.docker.com/r/gnaudio/jabra-xpress-analytics-cron%E4%BB%85%E5%85%81%E8%AE%B8%E5%8D%95%E5%AE%9E%E4%BE%8B%E9%83%A8%E7%BD%B2%EF%BC%8C%E5%A4%9A%E5%AE%9E%E4%BE%8B%E4%BC%9A%E5%AF%BC%E8%87%B4%E6%95%B0%E6%8D%AE%E5%86%B2%E7%AA%81

SQL数据库初始化

1. 准备SQL连接字符串（含数据库创建权限）
2. 使用https://hub.docker.com/r/gnaudio/jabra-xpress-databaseconsoletool%E5%88%9D%E5%A7%8B%E5%8C%96%E6%9E%B6%E6%9E%84%EF%BC%9A

   bash
   docker run --rm gnaudio/jabra-xpress-databaseconsoletool --connection "SQL连接字符串" --migrate
   

3. 无错误输出即表示数据库初始化完成

历史版本信息

v5.5.26802

v5.4.24001

v5.3.09401

v5.1.***

v5.0.***

重大变更

• NetworkEndpoint：移除URL中的/api/Xpress/Network/路径
• 新增安全配置：Security:PackageTokens:IssuerKey、Security:ClientTokens:IssuerKey、Security:TokenProtection:Key

v4.20.05402

v4.17.54803

参考链接

• Jabra Xpress 官方文档
• https://hub.docker.com/r/gnaudio/jabra-xpress-frontend
• https://hub.docker.com/r/gnaudio/jabra-xpress-databaseconsoletool