config.js

/**
 * 配置文件
 * 配置优先级：WEBDAV备份数据 > 环境变量 > config.js (本文件) > src/defaultConfig.ts (默认配置)
 */
module.exports = {
  // 同步服务名称
  // 环境变量: SERVER_NAME
  "serverName": "BoleServer",

  // 是否启用 DEBUG 模式 (开启后输出详细的调试日志与音源内部日志，默认关闭，供开发人员使用)
  // 环境变量: ENABLE_DEBUG (true/false)
  "debug.enabled": false,

  // 是否使用代理转发请求到本服务器 (如果配置了 proxy.header，此项会自动设为 true)
  // 环境变量: 无 (通过 PROXY_HEADER 隐式开启)
  "proxy.enabled": false,

  // 代理转发的请求头 原始IP
  // 环境变量: PROXY_HEADER
  "proxy.header": "x-real-ip",

  // 服务绑定IP (0.0.0.0 允许外网访问，127.0.0.1 仅限本机)
  // 环境变量: BIND_IP
  "bindIP": "0.0.0.0",

  // 服务监听端口
  // 环境变量: PORT
  "port": 9527,

  // 是否开启用户路径 (baseurl/用户名)
  // 开启后连接URL需包含用户名，允许不同用户使用相同密码。关闭后仅使用密码鉴权，要求所有用户密码唯一。
  // 环境变量: USER_ENABLE_PATH (true/false)
  "user.enablePath": true,

  // 是否开启根路径 (baseurl)
  // 开启后连接URL即为根路径，不允许不同用户使用相同密码。
  // 环境变量: USER_ENABLE_ROOT (true/false)
  "user.enableRoot": false,

  // 是否启用公开用户权限限制 (开启后将限制公开用户的某些敏感操作，如上传、删除自定义源)
  // 环境变量: ENABLE_PUBLIC_USER_RESTRICTION (true/false)
  "user.enablePublicRestriction": true,

  // 是否开启公开收藏和歌曲 (开启后允许公开/未登录用户查看及播放公开收藏列表)
  // 环境变量: ENABLE_PUBLIC_FAVORITES (true/false)
  "user.enablePublicFavorites": false,

  // 是否开启非管理员访问本地音乐 (开启后允许未登录管理员的公开账号访问本地音乐)
  // 环境变量: ENABLE_PUBLIC_NON_ADMIN_LOCAL_MUSIC (true/false)
  "user.enablePublicNonAdminLocalMusic": false,

  // 是否开启非管理员浏览器下载 (开启后允许未登录管理员的公开/普通账号使用浏览器下载歌曲)
  // 环境变量: ENABLE_PUBLIC_NON_ADMIN_BROWSER_DOWNLOAD (true/false)
  "user.enablePublicNonAdminBrowserDownload": true,

  // 是否开启非管理员服务器缓存 (开启后允许未登录管理员的公开/普通账号将歌曲缓存或写入服务器存储)
  // 环境变量: ENABLE_PUBLIC_NON_ADMIN_SERVER_CACHE (true/false)
  "user.enablePublicNonAdminServerCache": false,

  // 是否开启非管理员访问公开收藏和歌曲 (开启后允许未登录管理员的公开账号查看公开收藏和歌曲)
  // 环境变量: ENABLE_PUBLIC_NON_ADMIN_ACCESS (true/false)
  "user.enablePublicNonAdminAccess": false,

  // 是否启用自定义歌曲目录 (开启后使用自定义歌曲目录)
  // 环境变量: ENABLE_CUSTOM_MUSIC_DIR (true/false)
  "user.enableCustomMusicDir": false,

  // 是否启用登录用户缓存限制 (开启后将限制非管理员登录用户的核心缓存设置)
  // 环境变量: ENABLE_LOGIN_USER_CACHE_RESTRICTION (true/false)
  "user.enableLoginCacheRestriction": false,

  // 是否启用缓存空间限制 (开启后超出容量将按 LRU 自动清理)
  // 环境变量: ENABLE_CACHE_SIZE_LIMIT (true/false)
  "user.enableCacheSizeLimit": false,

  // 缓存空间限制大小 (单位: MB)
  // 环境变量: CACHE_SIZE_LIMIT
  "user.cacheSizeLimit": 2000,

  // 缓存文件自动保留天数 (单位: 天，0 为永久保留)
  // 环境变量: CACHE_MAX_AGE_DAYS
  "cache.maxAgeDays": 14,

  // 最大快照数 (用于数据回滚)
  // 环境变量: MAX_SNAPSHOT_NUM
  "maxSnapshotNum": 10,

  // 添加歌曲到列表时的位置，Web 播放器与 Subsonic API 均使用此配置 (top: 顶部, bottom: 底部)
  // 环境变量: LIST_ADD_MUSIC_LOCATION_TYPE
  "list.addMusicLocationType": "top",

  // 是否禁用数据收集
  // 环境变量: DISABLE_TELEMETRY (true/false)
  // 说明：仅收集版本号、运行环境（Docker/Node）、OS类型等非敏感信息用于项目改进。绝对匿名，不收集IP。
  "disableTelemetry": false,

  // 管理员密码（用于登录管理控制台和在音乐播放器界面登录管理员）
  // 留空时首次打开 /admin/ 设置密码；环境变量 ADMIN_PASSWORD 设置后由部署环境管理
  "admin.password": "",

  // 用户列表
  // 环境变量: LX_USER_<用户名>=<密码> (例如: LX_USER_user1=123456)
  // 如果需要通过环境变量设置高级选项，可将值设为JSON格式，例如：
  // LX_USER_admin={"password":"123","enableCustomMusicDir":true,"customMusicDir":"/data/music"}
  // 也可以在这里为特定用户配置独立的高级选项，例如：
  // "enableCustomMusicDir": false, // 是否启用此用户自定义歌曲目录
  // "customMusicDir": "", // 自定义歌曲目录绝对路径
  // "allowOperateCustomMusicDir": false, // 允许操作目录歌曲（如删除歌曲、洗版）
  // "allowWriteCustomMusicDir": false, // 允许写入歌曲文件（如手动关联、批量更新元数据、批量嵌入歌词）
  // "enableAutoDownload": false, // 启用此用户自动下载歌曲功能（允许将歌单内容自动同步下载至本地数据目录）
  // "maxSnapshotNum": 10, // 最大备份快照数
  // "list.addMusicLocationType": "top" // 添加歌曲到列表时的位置 (top | bottom)
  "users": [],

  // WebDAV 同步配置 (可选，用于数据备份)
  // 是否启用 WebDAV 同步与备份
  // 环境变量: WEBDAV_ENABLE (true/false)
  "webdav.enable": false,

  // WebDAV 服务地址
  // 环境变量: WEBDAV_URL
  "webdav.url": "",

  // WebDAV 用户名
  // 环境变量: WEBDAV_USERNAME
  "webdav.username": "",

  // WebDAV 密码
  // 环境变量: WEBDAV_PASSWORD
  "webdav.password": "",

  // WebDAV 增量同步远端路径
  // 环境变量: WEBDAV_SYNC_PATH
  "webdav.syncPath": "/lx-sync",

  // WebDAV 全量备份远端路径
  // 环境变量: WEBDAV_BACKUP_PATH
  "webdav.backupPath": "/lx-sync-backups",

  // 同步检测间隔 (分钟)
  // 环境变量: SYNC_INTERVAL
  "sync.interval": 60,

  // 全量备份间隔 (小时)
  // 环境变量: BACKUP_INTERVAL
  "sync.backupInterval": 24,

  // 是否排除缓存目录同步 (data/<用户>/cache)
  // 开启后，各用户缓存目录将不参与增量同步及全量备份；之前已同步到云端的文件不会被删除，只有开启后新产生的变动才会被跳过
  // 环境变量: WEBDAV_EXCLUDE_CACHE (true/false)
  "webdav.excludeCache": false,

  // 是否排除下载/音乐目录同步 (data/<用户>/music)
  // 开启后，各用户音乐下载目录将不参与增量同步及全量备份；之前已同步到云端的文件不会被删除，只有开启后新产生的变动才会被跳过
  // 环境变量: WEBDAV_EXCLUDE_MUSIC (true/false)
  "webdav.excludeMusic": false,

  // Web播放器名称
  // 环境变量: PLAYER_NAME
  "player.name": "BoleServer",

  // 是否启用 Web播放器 访问密码
  // 环境变量: ENABLE_WEBPLAYER_AUTH (true/false)
  "player.enableAuth": false,

  // Web播放器 访问密码
  // 环境变量: WEBPLAYER_PASSWORD
  "player.password": "123456",

  // 是否启用针对所有外发的请求代理 (目前主要用于离线音源的播放链接获取)
  // 环境变量: PROXY_ALL_ENABLED (true/false)
  "proxy.all.enabled": false,

  // 代理地址 (支持 http:// 或 socks5://)
  // 环境变量: PROXY_ALL_ADDRESS (例如: http://127.0.0.1:7890)
  "proxy.all.address": "",

  // 细分出站代理配置：音乐平台 / 自定义音源 / 应用功能
  // -------------------------------------------------------------
  // 配置说明（三种状态）：
  // 1. 沿用统一代理 (默认)：保持注释或设为 undefined，会自动继承 proxy.all.* 的开关与代理地址。
  // 2. 独立启用代理：取消注释并将 .enabled 设为 true，并在 .address 中填入该分类专属的代理地址 (留空则沿用统一地址)。
  // 3. 强制直连(不走代理)：取消注释并将 .enabled 设为 false，该类请求将强制直连，完全绕开任何代理（常用解决国内音乐平台被代理风控拦截的问题）。
  // -------------------------------------------------------------
  // 音乐平台 (内置音源 tx/wy/kg/mg/kw 等) 请求代理设置
  // "proxy.music.enabled": false, // 例如设为 false 强制音乐平台直连
  // "proxy.music.address": "",    // 单独的代理地址 (如 http://127.0.0.1:7890)

  // 自定义音源 (用户导入的第三方 JS 音源脚本发出的请求) 代理设置
  // "proxy.customSource.enabled": true,
  // "proxy.customSource.address": "",

  // 应用功能 (封面代理 / AcoustID 歌曲识别 / 远程音源导入等) 代理设置
  // "proxy.app.enabled": true,
  // "proxy.app.address": "",

  // 本地配置备份（每日生成一份 config.js 本地副本并自动清理过期备份）
  // 环境变量: CONFIG_BACKUP_ENABLE (true/false)
  "configBackup.enable": true,

  // 本地配置备份保留天数 (默认 7 天)
  // 环境变量: CONFIG_BACKUP_RETENTION_DAYS
  "configBackup.retentionDays": 7,

  // 本地配置备份目录 (留空默认为 <data>/backups，相对路径基于 data 目录，绝对路径直接使用)
  // 环境变量: CONFIG_BACKUP_DIR
  "configBackup.dir": "",

  // 歌单快照额外备份路径 (留空默认为用户数据目录 list/snapshot，相对路径基于 data 目录，绝对路径直接使用)
  // 环境变量: SNAPSHOT_BACKUP_PATH
  "snapshot.backupPath": "",

  // 后台管理界面访问路径（默认为 /admin）
  // 环境变量: ADMIN_PATH
  "admin.path": "/admin",

  // Web播放器访问路径（默认为根路径 /）
  // 环境变量: PLAYER_PATH
  "player.path": "/",

  // Subsonic 协议配置
  // 是否启用 Subsonic 协议支持 (服务默认开启)
  // 环境变量: SUBSONIC_ENABLE
  "subsonic.enable": true,

  // Subsonic 访问路径 (默认为 /rest)
  // 环境变量: SUBSONIC_PATH
  "subsonic.path": "/rest",

  // Subsonic 独立监听端口 (0 为不启用独立端口，共用主服务端口；>0 时单独监听指定端口)
  // 环境变量: SUBSONIC_PORT
  "subsonic.port": 0,

  // 是否开启 Subsonic 调试日志模式 (默认关闭)
  // 环境变量: SUBSONIC_ENABLE_DEBUG
  "subsonic.enableDebug": false,

  // 是否开启 Subsonic 在线全网搜索
  // 环境变量: SUBSONIC_ONLINE_SEARCH
  "subsonic.onlineSearch": true,

  // Subsonic 在线搜索模式 (fallback: 回退模式, merge: 合并模式, local_only: 仅本地)
  // 环境变量: SUBSONIC_ONLINE_SEARCH_MODE
  "subsonic.onlineSearchMode": "fallback",

  // Subsonic 在线搜索默认平台
  // 环境变量: SUBSONIC_ONLINE_SEARCH_SOURCES
  "subsonic.onlineSearchSources": "wy,tx,kw,kg,mg",

  // 是否开启 Subsonic 公开排行榜歌单 (将在线排行榜映射为只读歌单)
  // 环境变量: SUBSONIC_PUBLIC_LEADERBOARDS (true/false)
  "subsonic.publicLeaderboards": false,

  // Subsonic 公开排行榜默认音源平台 (tx / wy / kg / kw / mg)
  // 环境变量: SUBSONIC_LEADERBOARD_SOURCE
  "subsonic.leaderboardSource": "tx",

  // 是否在 Subsonic 歌词中包含翻译
  // 环境变量: SUBSONIC_LYRIC_TRANSLATION
  "subsonic.lyricTranslation": true,

  // 是否在 Subsonic 播放音乐时触发服务器缓存保存 (落盘到该用户缓存目录，已缓存自动跳过)
  // 环境变量: SUBSONIC_CACHE_ON_PLAY (true/false)
  "subsonic.cacheOnPlay": false,

  // 是否在 Subsonic 播放音乐时优先使用本地缓存/下载文件直接流式传输 (默认开启)
  // 环境变量: SUBSONIC_PLAY_CACHE_FIRST (true/false)
  "subsonic.playCacheFirst": true,

  // Subsonic 音质优选总开关 (按优先级主动选最优可用音质，关闭则仅做单次解析)
  // 环境变量: SUBSONIC_QUALITY_ENABLED (true/false)
  "subsonic.quality.enabled": true,

  // Subsonic 音质优先级列表 (从高到低，以英文逗号分隔)
  // 环境变量: SUBSONIC_QUALITY_PRIORITY (例如: flac,320k,128k)
  "subsonic.quality.priority": "flac,320k,128k",

  // 歌手信息源优先级 (多个源用逗号分隔，如 tx,wy)
  // 环境变量: SINGER_SOURCE_PRIORITY
  "singer.sourcePriority": [
    "tx",
    "wy"
  ],

  // 歌手歌曲最大抓取页数
  // 环境变量: ARTIST_MAX_FETCH_PAGES
  "artist.maxFetchPages": 20,

  // 缓存文件命名规则 (simple / custom)
  // 环境变量: CACHE_NAMING_PATTERN
  "cache.namingPattern": "simple",

  // 是否允许运行 VM 模式自定义源脚本 (默认关闭)
  // 环境变量: SYSTEM_ALLOW_UNSAFE_VM
  "system.allowUnsafeVM": false
}