【亲测免费】 Stream-rec 项目使用教程

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

Stream-rec 项目的目录结构如下：

stream-rec/
├── base/
├── common/
├── docs/
├── flv-processing/
├── gradle/
├── hls-processing/
├── platforms/
├── server/
├── stream-rec/
├── .dockerignore
├── .gitignore
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── README.md
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle.kts

目录介绍

• base/: 基础模块，包含项目的基础配置和通用工具。
• common/: 通用模块，包含项目中常用的工具类和辅助函数。
• docs/: 文档目录，包含项目的相关文档。
• flv-processing/: FLV 处理模块，负责处理 FLV 格式的直播流。
• gradle/: Gradle 构建脚本目录。
• hls-processing/: HLS 处理模块，负责处理 HLS 格式的直播流。
• platforms/: 平台模块，包含不同直播平台的处理逻辑。
• server/: 服务器模块，负责项目的后端服务。
• stream-rec/: 主模块，包含项目的核心逻辑和启动文件。
• .dockerignore: Docker 忽略文件。
• .gitignore: Git 忽略文件。
• CHANGELOG.md: 项目更新日志。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• build.gradle.kts: Gradle 构建脚本。
• gradle.properties: Gradle 配置文件。
• gradlew: Gradle 包装器脚本。
• gradlew.bat: Gradle 包装器脚本（Windows）。
• settings.gradle.kts: Gradle 设置文件。

2. 项目的启动文件介绍

Stream-rec 项目的启动文件位于 stream-rec/ 目录下，主要文件为 stream-rec.jar。

启动文件介绍

• stream-rec.jar: 这是项目的可执行 JAR 文件，包含了项目的所有依赖和核心逻辑。通过运行该文件，可以启动 Stream-rec 项目。

启动命令

java -jar stream-rec/build/libs/stream-rec.jar

环境变量配置

在启动项目时，可以通过设置环境变量来配置项目的行为。常用的环境变量包括：

• DB_PATH: SQLite 数据库路径（默认值：/db）。
• JWT_SECRET: JWT 令牌生成的密钥。
• LOG_LEVEL: 日志级别（默认值：info）。
• LOGIN_SECRET: 登录密码（默认值：stream-rec，如果未设置）。

例如：

java -DDB_PATH=/path/to/your/db -DLOG_LEVEL=DEBUG -DJWT_SECRET=SECRET -DLOGIN_SECRET=123 -jar stream-rec/build/libs/stream-rec.jar

3. 项目的配置文件介绍

Stream-rec 项目的配置文件主要包括 gradle.properties 和 settings.gradle.kts。

gradle.properties

该文件用于配置 Gradle 构建工具的属性，例如 Java 版本、编码格式等。

# 示例配置
org.gradle.java.home=/path/to/java/home
org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8

settings.gradle.kts

该文件用于配置 Gradle 项目的设置，例如项目名称、模块依赖等。

// 示例配置
rootProject.name = "stream-rec"
include("base", "common", "docs", "flv-processing", "gradle", "hls-processing", "platforms", "server", "stream-rec")

通过这些配置文件，可以灵活地调整项目的构建和运行环境。