Skip to content
forked from mebtte/cicada

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

License

Notifications You must be signed in to change notification settings

greek-zzf/cicada

 
 

Repository files navigation

知了

知了, 支持多用户的开源音乐服务. 更多请看详细介绍.

准备

  • 邮箱账号, 因为知了依赖邮箱验证码进行登录, 以及部分功能需要依赖邮箱实现, 所以需要邮箱服务进行邮件发送

部署

新建配置文件 config.json:

{
  "emailHost": "smtp.example.com",
  "emailUser": "example",
  "emailPass": "example-password"
}

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

Releases 下载并解压对应平台的二进制包, 通过下面命令指定配置文件并启动(以 x64 Linux 为例):

./cicada-linux-x64 start -c config.json

通过 localhost:8000 或者 {{ip}}:8000 访问知了服务.

目前只提供了几种主流平台的构建包, 其他平台可以参考构建文档自行构建.

常见问题

如何迁移数据 ?

知了所有数据都位于 {{base}} 目录下, 将 {{base}} 目录复制或者移动即可完成迁移.

如何安装 PWA ?

PWA 仅支持 HTTPS 或者 localhost, 知了目前暂不支持配置 HTTPS, 请使用 nginx 之类的工具进行 HTTPS 反向代理. Chrome 下安装方法请查看教程.

已知缺陷

  • 在 iOS/iPadOS 上处于后台无法自动播放下一首, 这是因为 Safari 会暂停处于后台页面的 JavaScript.
  • 在 Windows 下安装 PWA 后图标比其他应用图标要小, 这是因为 Windows 和 macOS 的图标占用空间不一致, PWA 无法同时兼容, 知了使用的是 macOS 图标尺寸.

开源协议

GPL

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.2%
  • JavaScript 1.2%
  • Other 0.6%