feat: 更新 README.md,移除内置视频源并提供用户自定义资源站配置说明

This commit is contained in:
katelya
2025-09-02 17:21:47 +08:00
parent fa958d0987
commit 53ef9281ba
+112 -3
View File
@@ -18,6 +18,8 @@
本项目自「MoonTV」演进而来,为其二创/继承版本,持续维护与改进功能与体验。保留并致谢原作者与社区贡献者;如有授权或版权问题请联系以处理。目标:在原作基础上提供更易部署、更友好、更稳定的体验。
> **🔔 重要变更通知**:应用户社区的宝贵建议,为确保项目的长期稳定运行和合规性,我们已将内置的视频源移除。现在用户需要自行配置资源站以使用本应用的完整功能。我们提供了经过测试的推荐配置文件,让您能够快速上手使用。
## ✨ 功能特性
### 🎬 核心播放功能
@@ -114,9 +116,21 @@ docker run -d \
2. 如果是本机安装,访问:`http://localhost:3000`
3. 输入你在第二步设置的密码即可进入
#### 第四步:自定义资源站(可选)
#### 第四步:自定义资源站配置
如果你有自己的资源站配置,可以挂载 `config.json` 文件:
> **📢 重要说明**:为确保项目的长期稳定运行和避免潜在的法律风险,应用户社区的建议,我们已将内置的视频源移除。现在需要用户自行配置视频源以正常使用本应用。
##### 🔗 获取推荐的资源站配置
为了方便用户快速上手,我们提供了一个经过测试的资源站配置文件:
**配置文件下载地址**: [https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file](https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file)
##### 📋 配置步骤
1. **下载配置文件**:点击上方链接下载 `config.json` 文件
2. **保存到本地**:将文件保存到服务器的合适位置(如 `/opt/katelyatv/config.json`
3. **挂载配置文件**:按以下命令重新启动容器
```bash
# 先停止并删除旧容器
@@ -135,6 +149,13 @@ docker run -d \
> **路径说明**:把 `/path/to/your/config.json` 替换成你的配置文件完整路径
> **Windows 示例**`-v C:/Users/你的用户名/Desktop/config.json:/app/config.json:ro`
##### 🛡️ 免责声明
- 提供的配置文件仅为方便用户测试和学习使用
- 所有视频源均来源于公开的网络资源,请用户自行判断使用的合法性
- 我们不对任何第三方视频源的内容、质量或合法性负责
- 建议用户仅使用合法、正版的视频源
### 🛠️ 常用管理命令
```bash
@@ -247,6 +268,31 @@ docker compose ps
3. 登录后访问 `http://你的服务器IP:3000/admin` 进入管理后台
4. 在管理后台可以配置资源站、管理用户等
#### 第五步:配置资源站
> **📢 重要提醒**:由于项目长期稳定运行的考虑,应用户建议已移除内置视频源,需要手动配置资源站。
##### 方法一:使用推荐配置文件(推荐)
1. **下载配置文件**[点击下载 config.json](https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file)
2. **修改 docker-compose.yml**:取消注释 volumes 部分
```yaml
# 将这两行的注释去掉
volumes:
- ./config.json:/app/config.json:ro
```
3. **重启服务**
```bash
docker compose down
docker compose up -d
```
##### 方法二:管理后台配置
1. 登录管理后台:`http://你的服务器IP:3000/admin`
2. 进入"站点配置"页面
3. 手动添加视频源 API 接口
### 🛠️ 管理命令
```bash
@@ -319,6 +365,20 @@ docker run --rm -v katelyatv-redis-data:/data -v $(pwd):/backup alpine tar xzf /
### 🔧 自定义资源站
> **📢 重要说明**:由于项目长期稳定性考虑,应社区用户建议已移除内置视频源,需要配置资源站后才能正常使用。
#### 方法一:使用推荐配置(推荐)
1. **下载配置文件**[点击下载 config.json](https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file)
2. **替换仓库配置**
- 在你 Fork 的仓库中找到 `config.json` 文件
- 点击编辑按钮(铅笔图标)
- 将下载的配置内容复制替换原有内容
- 点击 **Commit changes**
3. **等待重新部署**:Vercel 会自动重新部署(约 1-2 分钟)
#### 方法二:手动配置
如果你想添加自己的资源站:
1. 在你 Fork 的仓库中找到 `config.json` 文件
@@ -383,6 +443,22 @@ docker run --rm -v katelyatv-redis-data:/data -v $(pwd):/backup alpine tar xzf /
2. 点击最新部署旁的 **...** → **重试部署**
3. 等待部署成功
#### 第六步:配置资源站
> **📢 重要提醒**:为保障项目长期稳定运行,应用户建议已移除内置视频源,需要配置资源站。
##### 推荐配置方法:
1. **下载配置文件**[点击下载 config.json](https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file)
2. **更新仓库配置**
- 回到你的 GitHub 仓库
- 找到 `config.json` 文件,点击编辑
- 用下载的内容替换原有配置
- 提交更改
3. **等待自动部署**Cloudflare Pages 会自动重新构建部署
🎉 **完成!现在可以正常使用影视聚合功能了**
### 🗄️ 启用 D1 数据库(可选,支持多用户)
如果你想要用户系统和数据同步:
@@ -1033,7 +1109,40 @@ KatelyaTV 支持标准的苹果 CMS V10 API 格式。
</div>
## 🙏 致谢
## 推荐配置文件说明
### 🎯 为什么需要配置文件?
为了项目的长期稳定运行和合规性,我们根据用户社区的建议,将内置的视频源移除。这样做的好处包括:
- **🛡️ 降低法律风险**:避免项目因内置资源问题而受到影响
- **⚡ 提升加载速度**:减少应用本体大小,提高启动速度
- **🔧 更灵活配置**:用户可以根据需要选择最适合的资源站
- **📈 长期维护性**:确保项目能够持续健康发展
### 📥 获取推荐配置
我们为用户精心准备了一个经过测试和优化的配置文件:
**📂 配置文件下载链接**: [https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file](https://www.mediafire.com/file/xl3yo7la2ci378w/config.json/file)
### ✨ 配置文件特点
-**经过充分测试**:所有资源站均经过可用性验证
-**响应速度优化**:优选响应快速的资源接口
- 🎬 **内容丰富**:覆盖电影、电视剧、综艺、动漫等多种类型
- 🔄 **定期更新**:我们会根据可用性定期更新推荐配置
### 🛡️ 使用声明
- 提供的配置文件仅供学习交流和技术测试使用
- 所有资源均来源于公开的网络接口,请用户自行判断使用的合法性
- 我们不对任何第三方资源的内容质量或合法性承担责任
- 强烈建议用户仅使用合法、正版的影视内容
---
## 🙏 致谢
- [ts-nextjs-tailwind-starter](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter) — 项目最初基于该脚手架。
- [LibreTV](https://github.com/LibreSpark/LibreTV) — 由此启发,站在巨人的肩膀上。