ts3mb/ts3musicbot

TS3MusicBot Docker镜像文档

1. 注意事项

使用此容器前，您需要从 [*] 获取Bot许可证！**

2. 关于

您是否曾想在TeamSpeak或服务器上播放音乐？现在可以实现了！TS3MusicBot是一款适用于TeamSpeak或服务器的独特功能，完全支持Linux和Windows系统。

上传音乐文件、管理文件夹、播放各种音乐文件、流式传输网络电台、直接播放***和SoundCloud等链接。TS3MusicBot可通过聊天命令或内置Web界面进行控制。

在玩游戏时与团队一起听音乐，让朋友听你发现的***视频，与频道内其他人实时共享音乐体验。

3. 用法

Docker Create

bash
docker create \
--name=TS3MB \
-p 8080:8080 \
-p 9000:9000 \
-e ACCOUNT=my@account.net \
-e PASSWORD_ADMIN=admin \
-e PASSWORD_USER=user \
-v [/本地路径/bot_core]:/app/ts3mb_core \
-v [/本地路径/bot_media]:/app/ts3mb_media \
-v [/本地路径/shared/bot_temp]:/app/ts3mb_tmp \
-v /dev/shm:/dev/shm \
ts3mb/ts3musicbot

Docker Compose

yaml
version: '3.3'
services:
    ts3musicbot:
        ports:
            - '8080:8080'
            - '9000:9000'
        environment:
            - ACCOUNT=my@account.net
            - PASSWORD_ADMIN=admin
            - PASSWORD_USER=user
        volumes:
            - '[/本地路径/bot_core]:/app/ts3mb_core'
            - '[/本地路径/bot_media]:/app/ts3mb_media'
            - '[/本地路径/shared/bot_temp]:/app/ts3mb_tmp'
            - '/dev/shm:/dev/shm'
        restart: always
        image: docker.xuanyuan.run/ts3mb/ts3musicbot

4. 参数

必填参数

-e ACCOUNT=my@account.net - 您的许可账户  
-v [/本地路径/bot_core]:/app/ts3mb_core - Bot核心文件存储路径（不可被多个容器共享）  
-v [/本地路径/bot_media]:/app/ts3mb_media - 音乐文件存储路径（可被多个容器共享）  
-v [/本地路径/shared/bot_temp]:/app/ts3mb_tmp - 共享库存储路径（所有容器需使用相同路径）  
-v /dev/shm:/dev/shm - 共享内存访问，减少浏览器和播放器内存消耗

可选参数

Bot设置

-e BETA=true - 使用测试版Bot  
-e BIND_IP=23.45.278.90 - 将查询和Web界面绑定到指定IP  
-e BIND_IP_WEBINTERFACE=23.45.278.90 - 仅将Web界面绑定到指定IP  
-e CLP="" - 额外命令行参数  
-e CONFIG_NUMBER=1 - 仅私人许可证，指定加载的配置（值为1-6）  
-e CONNECT_OVER_PUBLIC_IP=23.45.278.90 - 通过公网IP连接  
-e DEMO_MODE=true - 禁用权限系统，所有人可使用管理员命令  
-e DISBALE_YTDL=true - 禁用下载功能  
-e DISABLE_CLICKABLE_URLS_CHECK=true - 强制启用TS3聊天中音乐搜索的可点击链接  
-e ENABLE_CLICKABLE_URLS=true - 启用TS3聊天中音乐搜索的可点击链接（内外端口相同时生效）  
-e EXAMPLE_FILES_MUSIC=/folder - 将示例音乐文件复制到ts3mb_media/music/examples（限100MB/50文件）  
-e EXAMPLE_FILES_RADIO=/folder - 将示例电台文件复制到ts3mb_media/radio/examples  
-e EXAMPLE_FILES_PLAYLIST=/folder - 将示例播放列表复制到ts3mb_media/playlist/examples  
-e EXAMPLE_FILES_FORCE=true - 强制清理目标文件夹（单向同步）  
-e FORCE_DISCORD_TXT_CHANNEL=3 - 强制Bot停留在Discord指定文本频道  
-e FORCE_DIRECT_MODE=true - 禁用间接播放模式  
-e FORCE_USERNAME=Bot234 - 强制Bot用户名  
-e HOSTERKEY=jhdzwjsh - 仅用于Hoster-API  
-e IDENTITY=ts3identity.ini - 启动时加载指定身份文件  
-e KEEP_LOGIN=true - 禁用自动登录种子生成  
-e MAX_DISKSPACE=500 - Bot可使用的最大磁盘空间（MB，不设置则无限制）  
-e OTC=true - 一次性代码（添加到密码和用户名）  
-e PASSWORD_ADMIN=admin - Web界面管理员密码（可见设置）  
-e PASSWORD_USER=user - Web界面用户密码（隐藏设置）  
  - 所有密码会自动Base64编码，未设置时启动时自动生成  
  - 可自定义Base64字符串，需前缀"b64"（如PASSWORD_ADMIN='b64dGVzdA=='对应dGVzdA==）  
-e PORTABLE=true - 便携模式启动（磁盘空间占用增加10倍，仅用于调试）  
-e QUERY=true - 以查询模式运行Bot  
-e SET_MUSIC_PERMISSIONS=true|force - 启动时尝试设置音乐库权限  
-e START_CHANNEL=3 - 启动时强制加入指定频道

健康检查

-e HEALTHI_DEBUG=true - 启用内部健康检查脚本调试模式  
-e DISABLE_HEALTHCHECK=true - 禁用健康检查（内部和外部）

网页浏览器功能

-e DISBALE_WEBBROWSER=true - 禁用网页浏览器  
-e WEBBROWSER_MEMLIMIT=300 - 浏览器内存限制（MB，默认300，0为无限制）  
-e WEBBROWSER_CPULIMIT=80 - 浏览器CPU限制（%，默认80，0为无限制）

最大生命周期功能

-e MAX_LIFETIME=300 - 容器运行指定秒数后停止  
-e MAX_LIFETIME_BLOCK=true - 达到最大生命周期后阻止容器重启（需重新创建容器重置）  
-e MAX_LIFETIME_WEBSTART=true - 首次登录时开始倒计时  
-e MAX_LIFETIME_COMMANDSTART=true - 首次命令执行时开始倒计时

桥接/中心功能

-e FORCE_BRIDGE_MODE=true - 强制启用桥接模式  
-e FORCE_BRIDGE_TOKEN=true - 强制使用指定桥接令牌  
-e FORCE_HUB_MODE=true - 强制启用中心模式

端口设置

-e PORT=8080 - Web界面端口（默认8080）  
-e STREAMPORT=9000 - 流媒体端口（默认9000）

重置功能

-e RESET_CORE=true - 每次启动时删除Bot核心文件夹  
-e RESET_MEDIA=true - 每次启动时删除媒体文件夹（**注意：会删除所有音乐**）  
-e RESET_SETTINGS=true - 启动时删除配置文件

运行时参数

-e PUID=1000 - 运行用户ID  
-e PGID=1000 - 运行用户组ID  
-e TZ=Europe/Berlin - 时区设置

5. 端口

-p 8080:8080 - Web界面端口  
-p 9000:9000 - 流媒体端口

私人许可证的不同Bot之间端口不应相同，否则可能导致"许可证过期或无法验证"问题。

6. 网络

使用docker network create创建新网络并使用。不支持主机网络（--net host）。

7. 推荐Docker容器/工具

清理工具

• https://docs.docker.com/config/pruning/
• 容器：https://hub.docker.com/r/liske/docker-prune

AutoHeal - 自动重启不健康容器

监控并重启不健康的Docker容器。
https://hub.docker.com/r/willfarrell/autoheal

Watchtower - 自动更新容器

监控Docker容器并在基础镜像更新时自动重启。
https://hub.docker.com/r/containrrr/watchtower

Portainer - Docker管理界面

轻量级管理UI，用于管理Docker主机或Swarm集群。
https://hub.docker.com/r/portainer/portainer

Nginx-Proxy - 子域名运行Bot

运行Nginx和docker-gen的容器，自动生成反向代理配置。

注意：需绑定自定义配置文件到/etc/nginx/conf.d/my_proxy.conf，例如：
-v /path/to/my_proxy.conf:/etc/nginx/conf.d/my_proxy.conf:r
配置文件内容：client_max_body_size 100M;（防止"413 Request Entity Too Large"错误）

https://hub.docker.com/r/jwilder/nginx-proxy

Lets-Encrypt - HTTPS支持

与Nginx-Proxy配合使用，自动创建、续期Let's Encrypt证书。
https://hub.docker.com/r/jrcs/letsencrypt-nginx-proxy-companion

local-persist驱动

允许创建指定路径的卷。
https://github.com/CWSpear/local-persist

8. 漏洞

漏洞报告位于镜像工作目录的"out/"文件夹：

• report-[digest].html：包含所有漏洞（包括未修复）
• report_no-unfixed_clean_version_[digest].html：仅包含已修复漏洞

9. 版本标签

• [latest]：最新稳定版
• [beta]：测试版
• [alpha]：测试版
• [nightly]：极不稳定的未测试版本（仅在支持人员指导下使用）
• [*-hub_only]：仅包含中心模式依赖的小型镜像（强制中心模式启动）
• [testing-*]：新功能测试版（仅在支持人员指导下使用）
• [version-*]：包含所有版本（包括nightly，不了解用途时请勿使用）

10. 最新变更

常规版本

版本 0.7.0 [nightly][alpha][beta][latest]

• e 升级至bookworm

版本 0.6.3

• + 添加新TS客户端所需的包
• e 更新包

版本 0.6.2

• f 将端口80暴露改为8080
• f 修复缺少账户凭证时的强制停止问题
• - 移除Dropbox报告

版本 0.6.1

• + 暴露端口

版本 0.6.0

• + 添加FORCE_BRIDGE_MODE
• + 添加FORCE_BRIDGE_TOKEN
• + 添加FORCE_HUB_MODE
• + 添加HUB-ONLY镜像
• + 添加SET_MUSIC_PERMISSIONS
• e 将关闭等待时间从2秒增加到5秒
• e 将Python更新至3.9
• e 将Debian更新至bullseye

版本 0.5.0

• + 添加DEMO_MODE
• + 添加HEALTHI_DEBUG
• + 添加FORCE_***_TXT_CHANNEL
• + 添加Aquasoft Trivy及漏洞报告
• + 快速内部健康检查（即使关闭时也能重启Bot）
• e 更改Bot更新页面的镜像链接
• e 改进RESET_SETTINGS
• e 健康检查支持桥接/中心模式
• e 改进控制台日志
• e 更改容器镜像构建流程
• f 修复新Bot的ts3mb_media文件夹权限问题
• f 修复容器内语言管理问题
• - 完全移除旧版RESET_SETTINGS
• - 完全移除旧环境变量检查
• - 移除Aquasoft Microscanner

版本 0.4.0

• + 添加Base64密码支持
• + 添加DISABLE_CLICKABLE_URLS_CHECK
• + 添加FORCE_WHISPER
• + 添加FORCE_DIRECT_MODE
• + 添加FORCE_CHANNEL
• + 添加START_CHANNEL
• + 添加IDENTITY
• + 添加DISBALE_WEBBROWSER
• + 添加WEBBROWSER_MEMLIMIT
• + 添加WEBBROWSER_CPULIMIT
• + 添加MAX_LIFETIME_COMMANDSTART
• + 添加EXAMPLE_FILES_MUSIC
• + 添加EXAMPLE_FILES_RADIO
• + 添加EXAMPLE_FILES_PLAYLIST
• + 添加EXAMPLE_FILES_FORCE
• + 添加rsync包
• e 所有密码自动Base64编码
• e 未设置密码环境变量时启动时自动生成
• e 增加内部共享内存
• f 修复MAX_LIFETIME_BLOCK功能

版本 0.3.5

• f 修复首次运行时"clibs.tar解压失败"问题

版本 0.3.4

• + 添加即将推出功能的依赖
• e 更改目录权限

版本 0.3.3

• + 添加便携模式启动选项
• + 完全支持重置设置
• e OTC（一次性代码）前缀从+改为-
• e 最大生命周期脚本等待重置设置脚本
• e 最大生命周期脚本和重置设置脚本等待Bot完全启动
• e 改进控制台输出

版本 0.3.2

• + 阻止使用旧环境变量启动

版本 0.3.1

• + 添加DISABLE_HEALTHCHECK
• + 添加OTC

版本 0.3.0

• e 从Debian Stretch升级至Buster
• e 改进配置变量
• + 支持流媒体端口
• + 时区设置
• + 镜像验证
• + Bot最大生命周期计时器

版本 0.2.3 [latest]

• f 添加TS3 Client 3.3.0依赖

版本 0.2.2

• + 添加keeplogin和enclickableurls环境变量

版本 0.2.1

• + 添加webif-bind-ip环境变量
• f 修复EOF错误
• f 修复参数问题

版本 0.2.0

• e 卷路径从/ts3mb改为/app/ts3mb
• e 标准端口从80改为8080
• e Bot以非root用户运行
• + 支持流媒体端口
• + 时区设置
• + 镜像验证
• + Bot最大生命周期计时器

版本 0.1.2（因安全原因删除）

• + 添加流媒体端口环境变量
• e 健康检查包含Bot更新

版本 0.1.1（因安全原因删除）

• e 添加新健康检查
• e 更改健康检查时间

版本 0.1.0（因安全原因删除）

• + 首次发布

11. 支持

支持的标签：[latest]、[alpha]、[beta]

• 在线支持
• 官方网站
• 邮件支持

12. 常见问题

为什么镜像体积这么大？

此镜像以非便携模式运行Bot，包含所有依赖库，因此镜像较大，但后续Bot下载的软件体积显著减小。第一个Bot约需1024MB空间，后续每个Bot仅需45-70MB。

出现"413 Request Entity Too Large"错误？

参考Nginx-Proxy部分的注意事项，配置client_max_body_size 100M;。

[私人许可证] "许可证过期或无法验证。请检查网络连接并确保许可证有效"

若通过私人许可证运行多个Bot，需将环境变量PORT改为其他值（如8080→8081）并修改-p参数（如-p 8080:8081）。许可证检查会认为同一端口运行多个Bot导致此问题。