Rainwave 项目安装与使用指南

Rainwave 项目安装与使用指南

rainwave Rainwave Site and Radio Controller 项目地址: https://gitcode.com/gh_mirrors/ra/rainwave

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

Rainwave 是一个用于控制外部播放器（如 MPD）或流媒体源（如 Ices 或 LiquidSoap）的系统。以下是项目的目录结构及各个部分的简要介绍：

• api: 包含 Rainwave API 的相关代码。
• backend: Rainwave 的后端代码，负责处理音乐播放等逻辑。
• etc: 存储配置文件和示例配置文件。
• lang: 包含多语言支持的相关文件。
• libs: Rainwave 使用的外部库。
• rainwave: Rainwave 的核心代码。
• static: 存储静态文件，如 CSS、JavaScript 和图片。
• systemd: 包含用于 systemd 的系统服务文件。
• templates: HTML 模板文件。
• LICENSE: 项目使用的 GPL-2.0 许可文件。
• Pipfile: PyPI 的依赖文件。
• README.md: 项目说明文件。
• 其他脚本和文件：包括数据库初始化、音乐库扫描、测试等脚本。

2. 项目的启动文件介绍

Rainwave 的启动主要涉及以下几个文件：

• db_init.py: 初始化数据库的脚本，用于创建数据库和相关的表结构。
• rw_backend.py: 启动 Rainwave 后端服务的脚本，它是连接 LiquidSoap 和 Rainwave 的桥梁。
• rw_api.py: 启动 Rainwave API 服务的脚本，提供前端页面和 API 接口。
• rw_scanner.py: 扫描音乐目录并更新数据库中音乐信息的脚本。

3. 项目的配置文件介绍

Rainwave 的配置文件位于 etc/ 目录下，主要包括：

• rainwave_reference.conf: Rainwave 的参考配置文件，包含了所有可配置项的详细说明。
• USER.conf: 用户自己的配置文件，应该基于 rainwave_reference.conf 创建并修改，以满足自己的需求。

配置文件中包含了数据库连接信息、音乐目录位置、网站设置等关键配置。以下是一些重要的配置项：

• song_dir: 音乐文件的存放目录。
• database_url: 数据库的连接字符串。
• development_mode: 是否开启开发模式。
• icecast_host 和 icecast_port: Icecast 服务器的主机名和端口。

在开始使用 Rainwave 前，必须仔细阅读并正确配置这些设置。

rainwave Rainwave Site and Radio Controller 项目地址: https://gitcode.com/gh_mirrors/ra/rainwave