Lavalink Docker镜像文档

镜像概述和主要用途

Lavalink Docker镜像是Lavalink项目的自动化构建镜像，旨在为需要音频流处理能力的应用提供便捷部署方案。Lavalink作为高性能音频发送器，广泛用于***机器人等场景，支持音频流的接收、处理与发送。该镜像通过自动化构建流程确保用户快速获取最新版本，简化部署与版本管理。

核心功能和特性

• 自动化构建：基于Lavalink源码（GitHub仓库）自动构建，确保镜像版本与源码更新同步。
• 多标签版本控制：提供多种标签格式，支持按分支、主版本号、完整版本号及Git哈希值精确指定镜像版本，满足不同场景的版本管理需求。
• 灵活配置支持：工作目录设为/opt/Lavalink，支持挂载自定义配置文件，实现配置持久化与个性化调整。

使用场景和适用范围

• ***机器人开发：作为音频处理核心组件，为机器人提供低延迟音频流发送能力。
• 音频服务集成：适用于需处理或转发音频流的应用，如语音聊天平台、在线教育系统等。
• 开发/测试环境：通过分支或版本标签快速搭建一致的开发、测试环境，确保版本兼容性。

使用方法和配置说明

镜像标签格式

支持以下标签格式，用于精确指定版本：

fredboat/lavalink:<branch>                  # 按分支命名（如dev、master）
fredboat/lavalink:<branch>-v<major_version> # 分支+主版本号（如dev-v2）
fredboat/lavalink:<branch>-v<full_version>  # 分支+完整版本号（如dev-v2.0.1）
fredboat/lavalink:<git_hash>                # Git提交哈希前8位（如d648861a）

示例标签：
fredboat/lavalink:dev、fredboat/lavalink:dev-v2、fredboat/lavalink:dev-v2.0.1、fredboat/lavalink:d648861a

基本使用（docker run）

命令格式

bash
docker run -d \
  --name lavalink \
  -p <host_port>:<container_port> \  # 端口映射（需与配置文件一致）
  -v /path/to/local/lavalink.yml:/opt/Lavalink/lavalink.yml \  # 挂载配置文件
  fredboat/lavalink:<tag>  # 指定镜像标签

示例（dev分支）

bash
docker run -d \
  --name lavalink \
  -p 2333:2333 \  # 映射端口（默认配置通常使用2333）
  -v ./lavalink.yml:/opt/Lavalink/lavalink.yml \  # 挂载本地配置文件
  fredboat/lavalink:dev

docker-compose配置示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  lavalink:
    image: fredboat/lavalink:dev  # 指定镜像标签
    container_name: lavalink
    restart: always
    ports:
      - "2333:2333"  # 端口映射（与配置文件中server.port一致）
    volumes:
      - ./lavalink.yml:/opt/Lavalink/lavalink.yml  # 挂载本地配置文件
    environment:
      - JAVA_OPTS=-Xmx512m  # 可选：设置JVM参数（如内存限制）

启动服务：

bash
docker-compose up -d

配置文件说明

核心配置通过lavalink.yml文件实现，需包含服务端口、认证密钥、音频源等信息。示例配置片段：

yaml
server:
  port: 2333          # 服务端口（需与端口映射一致）
  address: 0.0.0.0    # 监听地址
  password: "your_auth_key"  # 客户端连接密钥

lavalink:
  server:
    password: "youshallnotpass"  # 内部认证密钥
    sources:
      ***: true    # 启用***音频源
      soundcloud: true # 启用SoundCloud音频源
      # 其他音频源配置...

说明：配置文件需手动创建并挂载至容器/opt/Lavalink/lavalink.yml，详细配置项参考Lavalink***文档。

注意事项

• 分支构建限制：自动化构建仅支持dev和master分支，其他分支可能临时可用。
• Commit哈希镜像：并非所有Git提交哈希都有对应镜像，使用前需通过Docker Hub标签页确认版本存在。
• 配置权限：确保挂载的本地配置文件具有容器内用户可读权限，避免因权限问题导致启动失败。