frozenmountain/liveswitch-gateway

LiveSwitch Gateway 镜像文档

概述

LiveSwitch Gateway是LiveSwitch服务集群的核心组件，主要用于授权访问LiveSwitch平台，并提供中央消息代理服务，是其他LiveSwitch服务运行所依赖的基础。

核心功能

• 提供LiveSwitch平台的访问授权机制
• 作为中央消息代理，协调其他LiveSwitch服务间的通信

使用场景

适用于LiveSwitch服务集群部署，作为核心组件支撑整个集群的访问控制与消息流转，尤其适用于需要整合媒体服务、SIP连接等多组件的实时通信场景。

使用方法

快速开始

按以下步骤部署LiveSwitch Gateway：

1. 为服务器集群创建网络：

bash
sudo docker network create liveswitch

2. 设置Redis服务器（LiveSwitch默认存储引擎），可通过Docker启动：

bash
sudo docker run -d \
    --network liveswitch \
    --publish 6379:6379 \
    --restart always \
    --name redis \
    redis

3. 启动并配置Postgres：

bash
sudo docker run -d \
    --env POSTGRES_PASSWORD='password' \
    --network liveswitch \
    --publish 5432:5432 \
    --restart always \
    --name postgres \
    postgres

4. 若计划安装录制管理（Recording Management）、录制多路复用器（Recording Muxer）和录制移动器（Recording Mover）服务，需启动RabbitMQ并配置录制用Postgres数据库：

bash
# 启动RabbitMQ（含管理界面）
sudo docker run -d \
    --network liveswitch \
    --publish 5672:5672 \
    --publish 15672:15672 \
    --restart always \
    --name rabbitmq \
    rabbitmq:3-management

# 创建录制数据库
sudo docker exec -it postgres \
    psql "postgresql://postgres:password@localhost" -c "CREATE DATABASE recording;"

# 授予录制数据库权限
sudo docker exec -it postgres \
    psql "postgresql://postgres:password@localhost" -c "GRANT ALL PRIVILEGES ON DATABASE recording TO postgres;"

5. 启动LiveSwitch Gateway镜像：
   • 若不安装录制管理服务：

bash
sudo docker run -d \
    --env CONNECTIONSTRINGS:DEFAULT='postgres://postgres:password@postgres:5432/postgres' \
    --env CONNECTIONSTRINGS:CACHE='redis://redis' \
    --network liveswitch \
    --publish 8080:8080 \
    --publish 9090:9090 \
    --publish 8443:8443 \
    --publish 9443:9443 \
    --restart always \
    --name liveswitch-gateway \
    frozenmountain/liveswitch-gateway

• 若安装录制管理服务：

bash
sudo docker run -d \
    --env CONNECTIONSTRINGS:DEFAULT='postgres://postgres:password@postgres:5432/postgres' \
    --env CONNECTIONSTRINGS:CACHE='redis://redis' \
    --env Deployments:0:DeploymentId='Default' \
    --env Deployments:0:RecordingManagement:Enabled='true' \
    --env Deployments:0:RecordingManagement:AmqpUri='amqp://guest:guest@rabbitmq:5672' \
    --env Deployments:0:RecordingManagement:PostgresUri='postgres://postgres:password@postgres:5432/recording' \
    --network liveswitch \
    --publish 8080:8080 \
    --publish 9090:9090 \
    --publish 8443:8443 \
    --publish 9443:9443 \
    --restart always \
    --name liveswitch-gateway \
    frozenmountain/liveswitch-gateway

网络

• 信令端口：TCP端口8080上的/sync端点处理客户端应用、LiveSwitch媒体服务器及SIP连接器的HTTP和WebSocket信令流量；TCP端口8443（可选）用于TLS终止（HTTPS），需提供证书。
• 管理端口：TCP端口9090上的/admin端点处理控制台及REST API的HTTP管理流量；TCP端口9443（可选）用于TLS终止，需提供证书。

配置

LiveSwitch Gateway支持两级配置：

实例特定配置

针对单个Gateway实例的配置，推荐通过环境变量实现，也可使用JSON配置文件。

环境变量配置

环境变量名称与JSON属性映射遵循.NET Core约定，关键参数说明如下：

• CONNECTIONSTRINGS:DEFAULT
  Postgres连接URI，格式需符合https://github.com/ServiceStack/ServiceStack.Redis#redis-connection-strings，未提供时服务无法启动。

• CONNECTIONSTRINGS:CACHE
  与https://github.com/ServiceStack/ServiceStack.Redis#redis-connection-strings兼容的Redis连接字符串，默认值为`127.0.0.1`。

• TRUSTEDSERVERCERTIFICATESHA1FINGERPRINTS
  受信任证书的SHA-1指纹列表（十六进制，无冒号，不区分大小写），用于Redis加密流量（如Redis使用自签名TLS证书时）。

• ADMIN:IPADDRESSES
  管理服务（默认端口9090）绑定的IP地址或CIDR范围，未指定时使用所有网络接口。

• SYNC:IPADDRESSES
  信令服务（默认端口8080）绑定的IP地址或CIDR范围，未指定时使用所有网络接口。

JSON配置文件

若使用JSON文件，需放置于/app/FM.LiveSwitch.Gateway.Service.config.json，示例：

json
{
  "ConnectionStrings": {
    "Default": "postgres://postgres:password@postgres:5432/postgres",
    "Cache": "redis://redis"
  },
  "TrustedServerCertificateSha1Fingerprints": [],
  "Admin": {
    "IPAddresses": []
  },
  "Sync": {
    "IPAddresses": []
  }
}

可通过docker cp命令复制配置文件到容器：

bash
docker cp FM.LiveSwitch.Gateway.Service.config.json liveswitch-gateway:/app/FM.LiveSwitch.Gateway.Service.config.json

集群配置

集群配置包含部署、应用、通道及API密钥等全面设置，存储于Redis中，集群内服务器按需获取。配置方式：管理控制台、REST API或环境变量。详情参见集群配置。

应用配置

应用级配置详情参见应用配置。