知了 - 开源音乐服务器

```
项目地址：
https://github.com/mebtte/cicada
```

## 准备
邮件发送服务, 知了使用邮箱验证码进行登录以及部分功能依赖邮箱实现, 第三方邮件发送服务可以参考 网易邮箱 / QQ 邮箱 / Outlook 邮箱
FFmpeg[可选], 知了会自动检测 PATH 下是否有 ffmpeg, 有的话会调用 ffmpeg 进行音频压缩(无损音质不会进行压缩), 没有的话将不会进行音频压缩
## 部署
新建配置文件 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 访问知了服务. 目前只提供了几种主流平台的构建包, 其他平台可以参考构建文档自行构建.

## Docker
知了支持 Docker 镜像部署:
```
docker run -d \
  --restart=always \
  -p 8000:80 \
  -v $HOME/cicada-data:/data \
  -v $HOME/cicada-config.json:/config.json \
  --name cicada \
  mebtte/cicada
```
需要注意的是, 使用 Docker 镜像首次运行必须配置 initialAdminEmail, 否则无法完成初始化. 此外 Docker 镜像下会忽略 config 文件中的 data 和 port 配置项.
## 配置选项：
https://github.com/mebtte/cicada/blob/master/docs/config/index.md
```
配置项
配置文件支持 JSON 或 JSON5 格式.

data
type: string
optional
default: {{pwd}}/cicada
存放数据的目录.

port
type: number
optional
default: 8000
提供服务的端口.

emailHost
type: string
required
邮件服务器主机.

emailPort
type: number
optional
default: 465
邮件服务器端口.

emailUser
type: string
required
邮件服务器用户.

emailPass
type: string
required
邮件服务器用户密码.

initialAdminEmail
type: string
optional
初始管理员邮箱, 用于创建管理员账号, 如果未设置, 将会在首次运行服务时要求在 CLI 输入. 注意, 已完成初始化后该配置项不再生效!

mode
type: enum
optional
default: production
运行模式, production 表示生产模式, development 表示开发模式. 该配置项主要用于开发, 普通用户无需关注, 设置成 development 可能会导致知了无法正常工作.
```