Navidrome 开源项目使用教程

1. 项目的目录结构及介绍

Navidrome 项目的目录结构如下：

navidrome/
├── .github/
├── assets/
├── cmd/
│   └── navidrome/
│       └── main.go
├── docs/
├── migrations/
├── pkg/
├── scripts/
├── ui/
├── .gitignore
├── .golangci.yml
├── .prettierrc
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── go.mod
├── go.sum
├── reflex.conf
└── update-translations.sh

• .github/: 包含 GitHub 相关的配置文件，如 issue 模板等。
• assets/: 存放项目所需的静态资源文件。
• cmd/: 包含项目的主要执行文件，其中 navidrome/main.go 是项目的入口文件。
• docs/: 存放项目的文档文件。
• migrations/: 包含数据库迁移脚本。
• pkg/: 存放项目的各种包和库。
• scripts/: 包含项目所需的脚本文件。
• ui/: 包含前端代码和资源。
• .gitignore: Git 忽略文件配置。
• .golangci.yml: GolangCI-Lint 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• Dockerfile: Docker 镜像构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和任务自动化文件。
• README.md: 项目说明文件。
• go.mod: Go 模块依赖管理文件。
• go.sum: Go 模块依赖校验文件。
• reflex.conf: Reflex 配置文件。
• update-translations.sh: 更新翻译脚本。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/navidrome/main.go。这个文件是 Navidrome 应用程序的入口点，负责初始化配置、启动服务器等操作。

package main

import (
    "github.com/navidrome/navidrome/cmd"
)

func main() {
    cmd.Execute()
}

cmd.Execute() 函数负责处理命令行参数并启动 Navidrome 服务。

3. 项目的配置文件介绍

Navidrome 的配置文件通常是一个 YAML 或 JSON 文件，用于配置应用程序的各种参数。默认情况下，Navidrome 会读取环境变量或配置文件中的设置。

常见的配置项包括：

• MusicFolder: 音乐文件夹路径。
• Port: 服务器监听端口。
• LogLevel: 日志级别。
• UI: 前端配置。

配置文件示例（navidrome.yaml）：

MusicFolder: "/path/to/music"
Port: 4533
LogLevel: "info"
UI:
  Enable: true

通过配置文件，可以灵活地调整 Navidrome 的行为，以适应不同的使用场景。