fonoster/routr

Routr Server

下一代SIP服务器。

!https://github.com/fonoster/routr/workflows/publish%20to%20docker%20hub/badge.svg

Routr是一款轻量级SIP代理、位置服务器和注册器，为电信运营商、通信服务提供商和集成商提供可靠且可扩展的SIP基础设施。

有关Routr镜像的构建方式和使用方法的更多文档，请参见https://github.com/fonoster/routr%E3%80%82

可用版本

您可以通过https://hub.docker.com/repository/docker/fonoster/routr/tags?page=1%E9%A1%B5%E9%9D%A2%E6%9F%A5%E7%9C%8B%E6%89%80%E6%9C%89%E5%8F%AF%E4%BB%8EDocker Hub拉取的镜像。以"change type"词（如task、bug或feature）开头的Docker标签名称可供测试，可能随时被移除。一些重点标签包括：

• https://hub.docker.com/layers/fonoster/routr/1.0.0-rc6/images/sha256-4963904688c129e336e5520b80554940cdb56de9eeca1aa8a385c39602b4ff2a?context=explore%E3%80%81https://hub.docker.com/layers/fonoster/routr/1.0.0-rc6/images/sha256-4963904688c129e336e5520b80554940cdb56de9eeca1aa8a385c39602b4ff2a?context=explore
• https://hub.docker.com/layers/fonoster/routr/1.0.0-rc5/images/sha256-e8531d4b809fab926aa3e11ad0385557f546cfe1e547a13c3742e289a7fc620f?context=repo

安装

您可以克隆此仓库并手动构建。

git clone https://github.com/fonoster/routr
cd fonoster/routr:%%VERSION%%
docker build -t fonoster/routr:%%VERSION%% .

或者，您可以从Docker索引拉取此镜像。

docker pull fonoster/routr:%%VERSION%%

使用示例

以下是使用此镜像的基本示例。

docker run -it \
    -p 4567:4567 \
    -p 5060:5060 \
    -p 5060:5060/udp \
    -e EXTERN_ADDR=192.168.1.149 \
    -e DATA_SOURCE_PROVIDER=files_data_provider \
    -v $(pwd)/config:/opt/routr/config \
    fonoster/routr

环境变量

环境变量用于入口点脚本中渲染配置模板。您可以在docker run、docker-compose up或Kubernetes清单的env数组中指定这些变量的值。

• USER_AGENT - 将SIP头User-Agent设置为所需值
• DATA_SOURCE_PROVIDER - 定义数据提供器。内置提供器为files_data_provider和redis_data_provider。必填
• DATA_SOURCE_PARAMETERS - 数据源参数。例如：'host=redis,port=6379'
• BIND_ADDR - 将服务器绑定到指定的套接字地址
• EXTERN_ADDR - 要公布的IP地址
• LOCALNETS - 本地网络。与EXTERN_ADDR结合使用
• RECORD_ROUTE - 保持在信令路径内
• REGISTRAR_INTF - Internal使服务器使用从尝试注册的设备看到的IP和端口（received & rport）。默认为External
• ACCESS_CONTROL_LIST_DENY - 拒绝来自网络列表的传入流量
• ACCESS_CONTROL_LIST_ALLOW - 允许来自网络列表的传入流量
• REST_SERVICE_BIND_ADDR - REST服务监听地址
• REST_SERVICE_PORT - REST服务端口。默认为4567
• REST_SERVICE_MIN_THREADS - 最小线程分配。默认为8
• REST_SERVICE_MAX_THREADS - 最大线程分配。默认为200
• REST_SERVICE_TIMEOUT_MILLIS - 将拒绝持续时间超过此值的请求。默认为5000（5秒）
• REST_SERVICE_UNSECURED - 为REST调用禁用HTTPS。默认为false
• REST_SERVICE_KEY_STORE - 密钥库路径
• REST_SERVICE_KEY_STORE_PASSWORD - 密钥库密码
• REST_SERVICE_TRUST_STORE - 信任库路径
• REST_SERVICE_TRUST_STORE_PASSWORD - 信任库密码
• SECURITY_CONTEXT_KEY_STORE - 密钥库路径
• SECURITY_CONTEXT_KEY_STORE_PASSWORD - 密钥库密码
• SECURITY_CONTEXT_TRUST_STORE - 信任库路径
• SECURITY_CONTEXT_KEY_STORE_TYPE - 密钥库类型
• SECURITY_CONTEXT_CLIENT_AUTH_TYPE - 客户端认证类型。默认为Disabled。有关更多选项，请参见[***]
• SECURITY_CONTEXT_CLIENT_PROTOCOLS - 接受的TLS协议。默认为[TLSv1.2, TLSv1.1, TLSv1]
• SECURITY_CONTEXT_DEBUGGING - 开启或关闭SSL调试。默认为false
• CONFIG_FILE - 配置文件路径。默认为config/config.yml
• SALT - 用于定义JWT盐。默认情况下，Routr会自行生成
• SALT_FILE - 使用外部文件定义JWT
• EX_RTP_ENGINE_ENABLED - 如果启用，将通过RTPEngine发送所有媒体。默认为false
• EX_RTP_ENGINE_PROTO - 保留用于通过http、https和udp进行NG命令。目前仅支持http
• EX_RTP_ENGINE_HOST - RTPEngine的地址
• EX_RTP_ENGINE_PORT - RTPEngine的端口
• EX_UNIQUE_GATEWAY_PER_HOST_PORT - 如果启用，如果已存在具有相同主机和端口组合的网关，将产生错误。默认为false
• EX_CONVERT_TEL_TO_E164 - 如果启用，将在路由呼叫前将入口呼叫的号码转换为E164格式。默认为false

前缀为EX_的变量是实验性功能，未来可能会被移除或重命名。

暴露端口

• 5060 - UDP和TCP信令的默认SIP端口
• 5061 - TLS信令的默认SIP端口
• 4567 - 管理API的默认端口

卷

• /opt/routr/config - 如果使用redis_data_provider，在此挂载您的配置文件

贡献

请阅读https://github.com/fonoster/routr/blob/master/CONTRIBUTING.md%E4%BA%86%E8%A7%A3%E6%88%91%E4%BB%AC%E7%9A%84%E8%A1%8C%E4%B8%BA%E5%87%86%E5%88%99%E4%BB%A5%E5%8F%8A%E6%8F%90%E4%BA%A4%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E7%9A%84%E6%B5%81%E7%A8%8B%E3%80%82

作者

• https://github.com/psanders

另请参见参与此项目的https://github.com/fonoster/routr/contributors%E5%88%97%E8%A1%A8%E3%80%82

许可证

Copyright (C) 2020 by Fonoster Inc. MIT许可证（详见https://github.com/fonoster/routr/blob/master/LICENSE%EF%BC%89%E3%80%82