下载安装

安装指南

XSwitch以Docker镜像方式提供,需要先下载一些安装脚本,安装脚本在安装过程中需要从XSwitch官网上下载镜像及需要的资源文件,请保持网络畅通。在没有公网的环境下安装,请参考离线安装

以下步骤将安装最新的XSwitch v6.0.9正式版(v6.0.8及之后版本是基于Debian 12编译;之前版本都是基于Debian 11编译)和XSwitch v6.1.7.9开发版(此版本及之后版本是基于Debian 12编译;之前版本都是基于Debian 11编译)。

下载解压安装包

如果你有wget,可以通过如下命令下载:

社区版

wget https://xswitch.cn/download/xswitch-community-6.0.9.tar.gz --user xswitch --password password
wget https://xswitch.cn/download/xswitch-community-6.1.7.9.tar.gz --user xswitch --password password

或直接点击这里下载正式版 或直接点击这里下载开发版

企业版

wget https://xswitch.cn/download/xswitch-6.0.9.tar.gz --user xswitch --password password
wget https://xswitch.cn/download/xswitch-6.1.7.9.tar.gz --user xswitch --password password

或直接点击这里下载正式版 或直接点击这里下载开发版

我们推荐将XSwitch安装到以下位置(任选其一):

  • /usr/local/xswitch-community-6.0.9
  • /opt/xswitch-community-6.0.9
  • /root/xswitch-community-6.0.9
  • /home/yourname/xswitch-community-6.0.9

下列命令将XSwitch安装到/usr/local/xswitch-community-6.0.9目录下,请确保有写入权限,如果使用企业版则修改相应的目录。

tar zxvf xswitch-community-6.0.9.tar.gz -C /usr/local
cd /usr/local/xswitch-community-6.0.9

安装指令及详细说明

请严格按照以下步骤执行。

准备和初始化

make setup

执行此命令会自动从XSwitch官网下载声音文件和生成.env文件,.env里的参数为Docker容器运行时的环境变量。

注意.env文件在Linux下默认是个隐藏文件,可以使用ls -lafind . -name .envcat .env等命令显示,详见Docker关于.env文件的相关说明

打开.env文件,修改如下几个参数:

系统参数

EXT_IP=22.22.2.2     # 这是外网地址(如果是内网使用,填写内网地址即可)
LOCAL_IP=192.168.1.1 # 这是内网地址(如果是内网使用,填写内网地址即可),如果是Mac则无此参数
FREESWITCH_DOMAIN=demo.xswitch.cn # 这是填写域的地方(用户或分机的域,可根据需要自行设置,也可以设成IP地址)

Nginx 配置参数

NGINX_PROXY_IP=192.168.1.1 # 和LOCAL_IP填写相同内网地址即可,如果是Mac无需改动
HTTP_PORT=8080             # HTTP网址访问的端口(比如设置了8080,访问时输入http://ip:8080)

其他参数说明

以下参数基本不用改动

DSN=postgresql://xui:xui@127.0.0.1/xui # 数据库连接地址,Mac下路径稍有不同
SIP_PORT=7060                          # UDP注册端口号
SIP_TLS_PORT=7061                      # TLS注册端口号
SIP_PUBLIC_PORT=7080                   # public对应端口号,用于网关对接等
SIP_PUBLIC_TLS_PORT=7081               # TLS Public对应端口号
VERTO_WS_PORT=8081                     # Verto WS对应端口号
VERTO_WSS_PORT=8082                    # Verto WSS对应端口号
RTP_START=10000                        # RTP媒体允许使用的最小端口
RTP_END=10099                          # RTP媒体允许使用的最大端口
ESL_PORT=8021                          # ESL对应端口

注意,如果在NAT环境下(非host网络,在macOS上必须使用NAT)RTP端口段不要开得太大,否则会影响效率。如果在生产环境中使用,请咨询XSwitch系统支持工程师获取最佳配置方案。

启动

make up

启动系统。首次运行会自动拉取镜象。启动后,可以通过 http://你的服务器IP:8081 访问Web界面。默认用户名是admin,默认密码获取请关注小樱桃科技微信公众号,关注成功后,输入admin即可获取新版本密码。

检查

通过执行docker ps可查看 docker 服务是否已正常启动。

如果有服务启动出错,可通过执行docker logs -f xswitch查看xswitch容器相关日志(xswitch为容器名)。

通过执行make bash进入xswitch容器内部,然后输入fs_cli可以连接控制台查看系统运行情况。

前期准备