callforamerica/freeswitch

Kubernetes用Freeswitch 1.6镜像（含清单）

维护者

Joe Black | <***> | https://github.com/joeblackwaslike

镜像概述和主要用途

轻量级Freeswitch 1.6容器化镜像，专为Kubernetes环境设计。支持TLS和捕获服务器功能，缓存与数据库存储在ramfs上以获得最佳性能。基于自定义的Debian Linux (Jessie)版本构建，压缩后大小约为22MB，兼顾轻量化与功能性。

核心功能和特性

• 轻量级设计：基于自定义Debian Jessie，压缩后仅约22MB，资源占用低
• 性能优化：缓存和数据库使用ramfs存储，提升数据访问速度
• 安全支持：集成TLS功能，保障通信安全
• 捕获服务器：支持捕获服务器配置，满足通话录制等需求
• 高度可定制：通过环境变量灵活配置模块、编解码器、语言等核心组件
• Kubernetes适配：提供专用清单文件，便于在K8s环境部署和管理

构建环境

构建环境变量用于构建脚本中，用于调整版本号和设置构建阶段的其他选项。可通过同名构建参数覆盖其值。

该镜像包含大量自定义配置，允许轻松定制Freeswitch以满足自身需求，同时保持公共镜像的轻量化：

• ERLANG_VERSION：默认值为19.2
• FREESWITCH_VERSION：默认值为1.6
• KAZOO_CONFIGS_BRANCH：默认值为master
• FREESWITCH_INSTALL_MODS：默认值为commands,conference,console,dptools,dialplan-xml,enum,event-socket,flite,http-cache,local-stream,loopback,say-en,sndfile,sofia,tone-stream
• FREESWITCH_INSTALL_CODECS：默认值为amr,amrwb,g723-1,g729,h26x,ilbc,opus,shout,silk,siren,spandsp
• FREESWITCH_INSTALL_LANGS：默认值为en,es,ru
• FREESWITCH_INSTALL_META：默认值为空
• FREESWITCH_INSTALL_DEBUG：默认值为false
• FREESWITCH_LOAD_MODS：默认值为FREESWITCH_LOAD_MODULES:-g729,silk

以下变量为大多数Dockerfile的标准变量，用于减少重复并使脚本在不同项目间可重用：

• APP：freeswitch
• USER：freeswitch
• HOME：/opt/freeswitch

运行环境

运行环境变量用于入口脚本中，用于渲染配置模板、执行流程控制等。可在继承基础Dockerfile时覆盖这些值，或在docker run时指定，或在Kubernetes清单的env数组中配置：

• FREESWITCH_LOG_LEVEL：默认值为info，日志级别
• FREESWITCH_LOG_COLOR：默认值为true，是否启用彩色日志
• FREESWITCH_RTP_START_PORT：默认值为16384，RTP起始端口
• FREESWITCH_RTP_END_PORT：默认值为32768，RTP结束端口
• FREESWITCH_DISABLE_NAT_DETECTION：默认值为true，是否禁用NAT检测
• MOD_KAZOO_LISTEN_IP：默认值为0.0.0.0，Kazoo模块监听IP
• FREESWITCH_SEND_ALL_HEADERS：默认值为true，是否发送所有头部信息
• FREESWITCH_CAPTURE_SERVER：默认值为false，是否启用捕获服务器
• FREESWITCH_CAPTURE_IP：默认值为127.0.0.1，捕获服务器IP
• FREESWITCH_ENABLE_TLS：默认值为false，是否启用TLS

[待办] 完善这些描述。

使用场景和适用范围

• VoIP服务部署：适用于构建基于Freeswitch的 VoIP 服务器
• Kubernetes环境：专为K8s设计，支持容器编排和自动扩缩容
• 轻量级通信服务：适合资源受限环境，如边缘计算节点
• 定制化通信需求：支持灵活配置模块和编解码器，满足不同通信场景

详细使用方法和配置说明

Docker环境（预构建镜像）

所有GitHub上的docker-*仓库均通过CI流水线推送到Docker Cloud/Hub。

该镜像可通过以下途径获取：

• https://store.docker.com/community/images/callforamerica/freeswitch
• https://hub.docker.com/r/callforamerica/freeswitch
• 命令拉取：docker pull docker.xuanyuan.run/callforamerica/freeswitch

运行命令示例：

bash
docker run -d \
    --name freeswitch \
    -h freeswitch.local \
    -p "11000:10000" \
    -p "11000:10000/udp" \
    -p "16384-16484:16384-16484/udp" \
    -p "8021:8021" \
    -p "8031:8031" \
    -e "FREESWITCH_DISABLE_NAT_DETECTION=false" \
    -e "FREESWITCH_RTP_START_PORT=16384" \
    -e "FREESWITCH_RTP_END_PORT=16484" \
    -e "ERLANG_COOKIE=test-cookie" \
    --cap-add IPC_LOCK \
    --cap-add SYS_NICE \
    --cap-add SYS_RESOURCE \
    --cap-add NET_ADMIN \
    --cap-add NET_RAW \
    --cap-add NET_BROADCAST \
    docker.xuanyuan.run/callforamerica/freeswitch

注意：请参考“运行环境”部分获取可用环境变量列表。

注意：生产环境中，可能需要在主机网络栈中运行容器。此时需移除上述端口映射，并添加--net=host参数。在Kubernetes环境中，若使用提供的清单文件，此配置已预先处理。

Docker Compose环境

拉取镜像：

bash
docker-compose pull

启动应用及依赖：

bash
# 前台启动
docker-compose up --abort-on-container-exit

# 后台启动
docker-compose up -d

Kubernetes环境

编辑kubernetes/<environment>目录下的清单文件，以反映特定环境和配置。

创建Erlang Cookie密钥：

bash
kubectl create secret generic erlang-cookie --from-literal=erlang.cookie=$(LC_ALL=C tr -cd '[:alnum:]' < /dev/urandom | head -c 64)

创建Freeswitch凭据密钥：

bash
kubectl create secret generic freeswitch-creds --from-literal=freeswitch.event-socket.password=$(sed $(perl -e "print int rand(99999)")"q;d" /usr/share/dict/words)

部署Freeswitch：

bash
kubectl create -f kubernetes/<environment>