TrueConf Server Docker镜像文档

快速参考

• 维护者： TrueConf LLC
• 获取帮助： TrueConf知识库、TrueConf文档、TrueConf ***频道

什么是TrueConf Server？

TrueConf Server 是一款强大、高质量且高安全性的视频会议软件服务器。它专为在LAN或***网络中支持多达1600名参与者的多点会议而设计。TrueConf Server无需专用硬件，并包含适用于所有主流平台的客户端应用程序，使其成为易于设置的统一通信解决方案。

TrueConf Server视频会议平台可安装在Windows操作系统和多种Linux发行版上。为更便捷地部署，您可以使用此已包含TrueConf Server的Docker容器。

[***]

如何使用此镜像

运行以下命令前，您需要安装sudo应用，且用户名需属于相应用户组。若要检查是否已安装sudo，请运行sudo -V命令。若默认未安装，可使用apt install sudo（需在root账户下运行）安装。要将登录名为user的用户添加到sudo组，请运行sudo usermod -a -G sudo user。您还需将该用户添加到docker组，具体方法见***指南。

步骤1：下载并运行TrueConf Server容器

本文演示如何在Debian 10上安装运行TrueConf Server容器。

要自动创建并运行TrueConf Server容器，需使用docker run命令。若系统中无镜像文件，将自动从公共仓库下载：

sudo docker run [OPTIONS] trueconf/trueconf-server:stable

其中[OPTIONS]为附加参数。例如，首次运行的命令：

sudo docker run -d --network=host -p 80:80 -p 443:443 -p 4307:4307 -e ADMIN_USER=tc_admin -e ADMIN_PASSWORD=*** -v /home/user/trueconf/server:/opt/trueconf/server/var/lib trueconf/trueconf-server:stable

该命令将下载TrueConf Server镜像，创建并在后台运行容器，然后将终端控制权返回给用户。同时，TrueConf Server运行所需的所有必要端口将被打开。管理员可通过用户名tc_admin和密码***访问控制面板，TrueConf Server工作目录将挂载到主机目录/home/user/trueconf/server。

以下将介绍部分可与***指南中描述的标准Docker选项结合使用的参数。例如，可使用--name参数为容器命名，以便更便捷地使用。

主机网络连接（--network=host）

要建立容器与网络的连接，运行--network=host命令。这允许直接使用主机网络连接，无需打开TrueConf Server所需的所有端口。

若指定此参数，则无需配置下文所述的端口转发。但需确保主机上至少打开了必要端口80、443和4307。

端口转发（-p [host_port]:[container_port]/[protocol]）

将主机端口[host_port]绑定到容器端口[container_port]，使用[protocol]协议（未指定时默认使用tcp）。端口范围的指定方式相同，例如-p 53000-55000:53000-55000/udp。

必须转发TrueConf Server的 mandatory端口：80、443、4307。

若需提供TrueConf Server额外端口的访问（如WebRTC），还需指定这些端口：

sudo docker run -d -p 80:80 -p 443:443 -p 4307:4307 -p 53000-55000:53000-55000/udp -e ADMIN_USER=tc_admin -e ADMIN_PASSWORD=*** -v /home/$USER/trueconf/server/lib:/opt/trueconf/server/var/lib trueconf/trueconf-server:release

设置环境变量（-e [variable]=[value]）

为容器设置环境变量。可设置：

• -e ADMIN_USER=tc_admin -e ADMIN_PASSWORD=password：在容器内创建TrueConf Server管理员账户，登录名为tc_admin，密码为password。请注意，此用户与主机OS用户无关，因此可使用任何授权信息。

• -e INIT_DB=true：以强制模式创建初始使用的数据库集群。数据库挂载在主机卷上。此选项将删除所有先前的TrueConf Server设置，如注册信息、用户和组列表、会议配置文件等。仅视频会议录制文件会保留，但不会在控制面板中显示。

• -e ServerID=xxxx -e Serial=xxxx -e ServerName=xxxx：自动注册TrueConf Server（若已获取TrueConf Server注册密钥），其中：

  • ServerID – 服务器ID
  • Serial – 注册密钥（不含前四或五个字符，例如，若注册密钥为AAAAA-BBBB-CCCC-DDDD，则输入BBBB-CCCC-DDDD）
  • ServerName – 访问服务器的域名（FQDN），例如video.company.name。 请注意，必须同时输入这三个参数才能启动注册。

• -e ServiceAddress：用于从企业网络外部访问的视频会议服务器外部地址。若未设置，默认使用ServerName。

挂载目录（-v [host_path]:[container_path]）

将主机上的[host_path]目录挂载到容器的[container_path]目录。可使用目录挂载将日志文件和其他生成的服务器数据保存到[host_path]路径。这包括服务器设置、账户、会议列表、录制文件、SSL证书和用户脚本等数据。容器停止后，数据仍会保留，并在下次容器运行时可用。若主机上[host_path]不存在，将自动创建。

以下示例展示可用的挂载路径：

• -v /home/user/trueconf/server:/opt/trueconf/server/var/lib：将TrueConf Server工作目录中除日志文件外的所有文件保存到主机目录/home/user/trueconf/server。

• -v /home/user/trueconf/server/log:/opt/trueconf/server/var/log：将TrueConf Server运行时生成的日志文件保存到主机目录/home/user/trueconf/server/log。

• -v /path/to/custom/certs:/ssl：指定主机上包含SSL证书文件的目录/path/to/custom/certs，供容器中的服务器使用。挂载后，要应用SSL证书，请打开TrueConf Server控制面板，进入Web → HTTPS部分，在HTTPS模式下拉列表中选择使用自定义证书。点击测试配置并应用保存更改。

• -v /path/to/custom/scripts:/setup.d：挂载包含额外sh脚本文件的/path/to/custom/scripts卷，这些脚本将在容器启动时运行。

停止和重启容器

要停止容器，请运行命令：

sudo docker stop vcs_server

其中vcs_server是容器的名称或ID。要查看此参数，运行sudo docker ps -a命令，将获取所有容器的完整列表及其状态信息。

要重启已停止的容器，请运行命令：

sudo docker start vcs_server

一次性容器运行

出于测试目的，可能需要运行一次性容器。该容器停止后将自动删除。可通过运行--rm实现。

以下是指定管理员登录名和密码的一次性容器启动命令示例：

sudo docker run --rm --network=host -p 80:80 -p 443:443 -p 4307:4307 -e ADMIN_USER=tc_admin -e ADMIN_PASSWORD=*** trueconf/trueconf-server:stable

步骤2：注册TrueConf Server

若未通过-e参数提前注册TrueConf Server，可通过TrueConf Server控制面板注册。在局域网内任何计算机的浏览器中打开控制面板，输入运行容器的服务器IP地址即可。

步骤3：添加TrueConf Server管理员

在添加具有控制面板管理员访问权限的新用户前，请确保容器已运行，且其/opt/trueconf/server/var/lib目录已按前文所示挂载到主机的/home/user/trueconf/server目录。

需通过以下命令创建三个授权文件：

sudo touch /home/user/trueconf/server/docker/passwd /home/user/trueconf/server/docker/tcadmins /home/user/trueconf/server/docker/tcsecadmins

其中：

• passwd – 包含登录名和加密密码
• tcadmins – 具有完全访问权限的服务器管理员登录名列表
• tcsecadmins – 具有安全管理员访问级别的服务器管理员登录名列表

之后，请执行以下步骤：

1. 安装apache2-utils工具包，其中包含用于管理密码的htpasswd： sudo apt install -yq apache2-utils

2. 为新登录名生成密码。密码将保存到当前终端所在目录的passwd文件中： htpasswd -c -d -b passwd new_admin password 其中：

   • new_admin – 新管理员的登录名
   • password – 密码

3. 将生成的passwd文件内容添加到主机挂载卷上的/home/user/trueconf/server/docker/passwd文件中。可使用vim或nano等文本编辑器（需在root账户下或使用sudo运行），也可运行以下命令： sudo bash -c 'cat passwd >> /home/user/trueconf/server/docker/passwd'

4. 根据要授予管理员的访问级别，将新管理员登录名添加到tcadmins或tcsecadmins文件中： sudo bash -c 'echo new_admin >> /home/user/trueconf/server/docker/tcadmins'

5. 要检查管理员是否添加成功，请访问TrueConf Server访客页面，点击管理员登录，使用新账户登录。

步骤4：设置容器自动运行

要使TrueConf Server容器在主机重启后自动启动，请使用--restart参数。可通过update命令指定该参数：

sudo docker container update --restart always vcs_server

其中vcs_server是容器的名称或ID。

也可在容器运行时设置此参数。

可使用sudo docker ps命令查看运行中的容器信息。