知了, 支持多用户的开源音乐服务.

• 尊重隐私, 不进行任何数据收集
• 支持多用户
• 支持用户间共享乐单
• 支持导入现有音乐目录/文件
• 支持 PWA, 同时适配桌面端和移动端
• 播放列表/播放队列分离, 可定制播放队列
• 支持标注音乐创作来源(翻唱)
• 支持歌词/歌名/歌手/乐单搜索
• 支持系统媒体和系统快捷键
• 暴露 HTTP API 支持第三方接入或进行二次开发

• 邮件发送服务, 知了使用邮箱验证码进行登录以及部分功能依赖邮箱实现. 使用邮箱验证码登录可以极大地提高安全性, 相比账号密码的登录方式, 邮箱验证码登录可以避免被暴力破解. 第三方邮件发送服务可以参考 网易邮箱 / QQ 邮箱 / Outlook 邮箱.

新建配置文件 config.json:

{
  "emailHost": "smtp.example.com",
  "emailUser": "[email protected]",
  "emailPass": "example-password"
}

完整配置可以参看配置项, 支持 JSON/JSON5 语法.

在 Releases 下载并解压对应平台的二进制包, 通过下面命令指定配置文件并启动服务:

# 首次运行将会提示输入首位用户邮箱
./cicada start -c config.json

通过 localhost:8000 或者 {{ip}}:8000 访问知了服务. 目前只提供了几种主流平台的构建包, 其他平台可以参考构建文档自行构建.

知了支持 Docker 部署, 启动容器之前请先参考上面准备知了的配置文件, 需要注意的是首次运行必须配置 firstUserEmail, 否则无法完成初始化.

通过 Docker 运行知了会忽略配置文件中的 data 和 port

docker run \
  -d \
  --restart=always \
  -p 8000:80 \
  -v $HOME/cicada/config.json:/config/cicada.json \
  -v $HOME/cicada/data:/data \
  --name cicada \
  mebtte/cicada

• 知了容器使用 80 端口提供服务, -p 8000:80 表示映射到宿主的 8000 端口
• 知了容器配置文件位于 /config/cicada.json, -v $HOME/cicada/config.json:/config/cicada.json 表示映射到宿主的 $HOME/cicada/config.json
• 知了容器数据保存在 /data, -v $HOME/cicada/data:/data 表示映射到宿主的 $HOME/cicada/data

如果不希望知了容器以 root 运行, 可以通过 --user {uid}:{gid} 指定.

version: '3'
services:
  cicada:
    restart: always
    container_name: cicada

    # 默认使用 root, 也可以通过 user 指定
    # user: 1000:1000

    image: mebtte/cicada
    ports:
      - 8000:80
    volumes:
      - /path/config.json:/config/cicada.json
      - /path/data:/data

知了支持导入现有音乐, 通过 cicada import 命令可以导入音乐目录或者音乐文件, 需要注意的是音乐文件命名必须要满足以下格式(多个空格会被合并成一个):

singer1[,singer2][,singer3] - name.format

比如 周杰伦 - 晴天.mp3 / Jarryd James,BROODS - 1000x.flac 是支持的命名, 孙燕姿 逆光.mp3 / 漠河舞厅.m4a 是不支持的命名.

# 导入音乐目录
cicada import --data /path_to/cicada_data --recursive music_dir

# 导入音乐文件
cicada import --data /path_to/cicada_data music

当遇到命名不支持或者格式不支持的文件, 知了将会忽略. 可以通过 cicada help import 查看更多选项.

v0 升级到 v1 需要对数据进行升级后才能启动服务:

# 进行数据升级前请先备份
cicada data-upgrade <data>

也可以通过 Docker 执行:

# 默认使用 root 用户, 也可以使用 --user {uid}:{gid} 指定
docker run -it --rm -v <data>:/data mebtte/cicada cicada data-upgrade /data

如果不想升级到 v1, 请继续使用 v0 版本的包或 Docker 镜像使用标签 mebtte/cicada:v0.

• 悬浮歌词面板(类似于网易云音乐网页版歌词)
• 电台
• 音乐分享(独立页面, 独立资源链接)

GPL