Skip to content

armgit / peach

Public Imported from GitHub
0

Peach: Local-first video metadata scraper and media manager.

docs(public): 统一影片刮削定位与公开展示边界

longmeidao88e5ce3d8f75
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 0084c51f1..13309885b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -35,6 +35,8 @@ Search existing issues first. Report security vulnerabilities privately at the l
<!--
粘贴完整报错,或附截图、相关日志、诊断报告。不需要自行判断根因。
上传前检查并遮盖本机路径、网络地址、账号及凭据等隐私信息。
+公开截图和录屏请使用不含露骨画面的演示资料;不要上传影片、封面原图或数据库。
Paste the full error or attach screenshots, relevant logs, or a diagnostic report. No root-cause analysis is required.
Review attachments and redact private information such as local paths, network addresses, accounts, and credentials.
+Use demo data without sexually explicit imagery in public screenshots and recordings. Do not upload videos, original cover images, or databases.
-->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 36a1f8c02..bbf41f46e 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -17,3 +17,4 @@ type: Feature
## 补充(可选)/ Additional context (optional)
<!-- 现有替代方案、截图或参考链接。/ Current workarounds, screenshots, or reference links. -->
+<!-- 公开截图和录屏使用不含露骨画面的演示资料,并遮盖隐私信息。/ Use demo data without sexually explicit imagery in public screenshots and recordings, and redact private information. -->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1868486c4..3e31b2667 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,6 +11,10 @@ Peach 是单人自托管应用,由一个人维护。欢迎提 Issue 和 PR。
## 开 Issue
+公开截图、录屏和附件使用不含露骨画面的演示资料,并遮盖隐私信息;不要上传影片、封面原图或数据库。公开内容与素材许可要求见[文档规范](docs/WRITING.md#公开与私有记录)。
+
+Use demo data without sexually explicit imagery in public screenshots, recordings and attachments. Redact private information, and do not upload videos, original cover images or databases.
+
- **报缺陷**:写清 Peach 版本或构建、系统版本及架构、安装方式、复现步骤、期望结果和实际结果,附上完整报错。无法稳定复现时说明发生条件,不要求自行判断根因。Python 版本仅用于源码部署,可选;`/healthz` 返回也可选,服务无法启动时写「无法访问」即可。贴日志或诊断报告前先遮盖本机路径、网络地址、账号及凭据。
- **提需求**:写清问题和使用场景。开放需求见 [公开路线图](https://github.com/orgs/peach-mitao/projects/7),设计边界见 [总体架构](docs/ARCHITECTURE.md#明确不做)。涉及多用户、云托管、微服务或 PostgreSQL 的提案,先讨论是否需要新增 ADR。
- **安全问题**:不要开公开 issue,按 [`SECURITY.md`](SECURITY.md) 私下报告。
diff --git a/README.en.md b/README.en.md
index fc2063b2e..ca2e28781 100644
--- a/README.en.md
+++ b/README.en.md
@@ -4,7 +4,7 @@
<h1 align="center">Peach</h1>
-<p align="center">A private video library: local drives, cloud drives and the creators you follow, all in one place.</p>
+<p align="center">A local-first video metadata scraper and media manager for local drives, cloud drives and creator updates.</p>
<p align="center">
<a href="https://peach.video">Website</a> ·
@@ -24,10 +24,9 @@
<a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0--or--later-blue?logo=gnu&amp;logoColor=white" alt="license"></a>
<a href="docs/TESTING_DESKTOP.md"><img src="https://img.shields.io/badge/Windows-x64-0078D4" alt="Windows x64"></a>
<a href="docs/OPERATIONS.md#macos-独立测试包"><img src="https://img.shields.io/badge/macOS-DMG-555555?logo=apple&amp;logoColor=white" alt="Build and install the standalone macOS app"></a>
- <img src="https://img.shields.io/badge/18%2B-adult%20content-critical" alt="18+ adult content">
</p>
-> Use Peach to manage media you own or are authorized to use. Adult content is for adults only and remains subject to applicable laws, copyright and source-platform terms. Peach does not provide video resources or access to paid content.
+> Use Peach to manage media you own or are authorized to use, subject to applicable laws, copyright and source-platform terms, including age and regional restrictions. Peach does not provide video resources or access to paid content.
Public screenshots use movie demo data with documented sources and licenses, without personal collection media; see [asset credits and licenses](https://peach.video/en/credits/). The repository includes a seed of public textual metadata and brand marks, without collection media or user databases. Access to outside sites requires the appropriate accounts and permissions.
@@ -44,7 +43,7 @@ Public screenshots use movie demo data with documented sources and licenses, wit
- **Manage tags**: local and online details share controls for adding, renaming and removing tags. Follow management supports merging tags, hiding tags in batches, and blocking or restoring content by tag. Names are preserved as aliases. See [tag management](docs/TAG_MANAGEMENT.md).
- **Find your next watch**: subscribe to performers' new releases, discover titles based on your taste and save them to your want list.
- **Cloud download**: search by video code or paste a magnet link, send it to a library with cloud download support and organize the downloaded video automatically. Channels follow configured libraries and provider capabilities, through CloudDrive2 or a direct PikPak connection. Confirm your rights to access and use the content before submitting it.
-- **Add JAV from your browser**: detect or select a video code on a supported metadata page, then send it to Peach for cloud download and library ingestion. The [userscript](https://github.com/peach-mitao/peach-userscript) is maintained independently; see [supported sources, installation and pairing](docs/JAV_BROWSER.md).
+- **Add videos from your browser**: detect or select a video code on a supported metadata page, then send it to Peach for cloud download and library ingestion. The [userscript](https://github.com/peach-mitao/peach-userscript) is maintained independently; see [supported sources, installation and pairing](docs/JAV_BROWSER.md).
- **Taste preferences**: combine viewing, feedback, your library, browser history, bookmarks and follows to understand your preferences. Read history and bookmarks from supported local browsers in one action, or import HTML bookmarks and Chromium Bookmarks JSON. Stop reading a source or remove it when needed. See [taste data sources](docs/TASTE_SOURCES.md).
Watch history, favorites and settings stay on your computer. Scanning leaves original files untouched; manual organization offers a preview and an undo for the last batch. Release codes are recognized even when the file name carries a title; for other naming schemes, add [recognition rules](docs/OPERATIONS.md#配置页) on the configuration page instead of renaming files.
@@ -59,7 +58,7 @@ System diagnostics generate reports and selected scraping records in the backgro
First-time setup lets you choose the Peach proxy for metadata requests and dependency downloads. Windows, macOS and Docker distributions include an isolated amane runtime; source and wheel installations prepare Peach's locked version automatically when first needed. If preparation fails, pending items remain available for retry after fixing the network or runtime.
-Scanning and collection show video and recognizable JAV counts, with incremental checks for new folders. Traffic estimates use pending work, local caches, deduplicated release codes, and local samples of similar operations. Before starting, you can also review estimated additional disk usage, temporary frame files, and free space on each output drive. Library settings read and save CloudDrive API and data proxies; traffic totals follow each linked folder's connection setting. Proxy protection limits automatic video reads. See [configuration](docs/OPERATIONS.md#配置页) for measurement coverage and estimation limits.
+Scanning and collection show video and recognizable code counts, with incremental checks for new folders. Traffic estimates use pending work, local caches, deduplicated release codes, and local samples of similar operations. Before starting, you can also review estimated additional disk usage, temporary frame files, and free space on each output drive. Library settings read and save CloudDrive API and data proxies; traffic totals follow each linked folder's connection setting. Proxy protection limits automatic video reads. See [configuration](docs/OPERATIONS.md#配置页) for measurement coverage and estimation limits.
The combined "Send version statistics and error diagnostics (recommended)" option is checked by default. Clear it during installation, first setup or in settings to disable both. Saved opt-out choices are preserved. While enabled, it sends the listed technical fields to Sentry; full logs, diagnostic ZIPs, media details and watch history are excluded. See [remote diagnostics](docs/DIAGNOSTICS.md#可选远程诊断).
@@ -137,7 +136,7 @@ For LAN access on fnOS or another NAS, set Compose's `PEACH_BIND` to the NAS LAN
## Reporting problems
-Check [user feedback](https://github.com/peach-mitao/peach/issues), or [open an issue](https://github.com/peach-mitao/peach/issues/new/choose) with the version, steps, expected result and actual result. Hide credentials, LAN addresses and full paths in screenshots; do not upload databases or media. Report security issues privately through the [security policy](SECURITY.md).
+Check [user feedback](https://github.com/peach-mitao/peach/issues), or [open an issue](https://github.com/peach-mitao/peach/issues/new/choose) with the version, steps, expected result and actual result. Use demo data without sexually explicit imagery in public screenshots, and hide credentials, LAN addresses and full paths; do not upload databases or media. Report security issues privately through the [security policy](SECURITY.md).
## Documentation
diff --git a/README.md b/README.md
index 74911fd8c..5ac80a9ba 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
<h1 align="center">Peach</h1>
-<p align="center">给自己用的私人影片馆藏:本地硬盘、网盘和关注的创作者,放在一个地方看。</p>
+<p align="center">本地优先的影片刮削与媒体管理工具:整理影片资料,浏览本地硬盘、网盘和创作者更新。</p>
<p align="center">
<a href="https://peach.video">官网</a> ·
@@ -24,10 +24,9 @@
<a href="LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0--or--later-blue?logo=gnu&amp;logoColor=white" alt="license"></a>
<a href="docs/TESTING_DESKTOP.md"><img src="https://img.shields.io/badge/Windows-x64-0078D4" alt="Windows x64"></a>
<a href="docs/OPERATIONS.md#macos-独立测试包"><img src="https://img.shields.io/badge/macOS-DMG-555555?logo=apple&amp;logoColor=white" alt="macOS 独立应用构建与安装"></a>
- <img src="https://img.shields.io/badge/18%2B-adult%20content-critical" alt="18+ 成人内容">
</p>
-> 仅用于管理自行持有或获授权使用的媒体。涉及成人内容时仅限成年人,并遵守适用法律、版权与来源平台条款;Peach 不提供影片资源或付费内容访问权。
+> 仅用于管理自行持有或获授权使用的媒体,并遵守适用法律、版权与来源平台条款,包括来源的年龄和地区限制。Peach 不提供影片资源或付费内容访问权。
公开截图使用有来源与许可记录的电影演示资料,不含个人馆藏,见[素材来源与许可](https://peach.video/credits/)。仓库包含用于补齐资料的公开文字事实种子与品牌标识,不包含馆藏媒体和用户数据库;连接外部站点需有相应账号和访问权。
@@ -44,7 +43,7 @@
- **跨站关注**:按已配置的来源汇总创作者更新,同一作品合成一张卡;来源支持和访问条件见[来源采集](docs/SOURCING.md)。
- **追新作、找想看的**:按人物订阅新作,按口味发现作品,用「想要」清单留住待找的片子。
- **云下载**:按番号查找或粘贴磁力,提交到支持云下载的媒体库,落地后自动整理入库。渠道随媒体库与网盘能力生成,支持 CloudDrive2 和 PikPak 直连;提交前须确认具有相应访问与使用权。
-- **浏览器添加 JAV**:在支持的资料页识别或选中番号,一键交给 Peach 云下载入库。[用户脚本](https://github.com/peach-mitao/peach-userscript)独立维护,来源范围与使用条件见[安装与配对](docs/JAV_BROWSER.md)。
+- **从浏览器添加影片**:在支持的资料页识别或选中影片编号,一键交给 Peach 云下载入库。[用户脚本](https://github.com/peach-mitao/peach-userscript)独立维护,来源范围与使用条件见[安装与配对](docs/JAV_BROWSER.md)。
- **口味**:结合观看、反馈、馆藏、浏览历史、书签与关注关系分析偏好。一次读取本机浏览器的历史和书签,也可导入 HTML 书签或 Chromium Bookmarks JSON;来源可停止读取或删除。见[口味数据来源](docs/TASTE_SOURCES.md)。
观看记录、收藏和设置保存在本机。扫描不动原文件;手动整理先预览,可撤回上一批。文件名带片名也能识别番号,特殊命名可在配置页补写[识别规则](docs/OPERATIONS.md#配置页),不必为 Peach 改名。
@@ -59,7 +58,7 @@
首次设置可选择 Peach 代理,保存后用于资料采集与依赖下载。Windows、macOS 与 Docker 随附 amane 独立运行环境;源码和 wheel 在首次需要时按 Peach 锁定版本自动准备。准备失败会保留待处理项目,修复网络或运行环境后可重试。
-扫描与采集显示视频与可识别 JAV 数量,首次目录分批预检;流量按待处理资料、缓存、同番号去重和本机同类样本估算,运行中显示已用流量和预计总流量。启动前还可查看预计新增磁盘占用、抽帧临时文件和各盘剩余空间。媒体库设置可读取和保存 CloudDrive 的 API/数据代理,按对应目录的连接方式汇总流量;“代理保护”限制自动读取视频。统计范围与估算限制见[运行与配置](docs/OPERATIONS.md#配置页)。
+扫描与采集显示视频与可识别编号数量,首次目录分批预检;流量按待处理资料、缓存、同番号去重和本机同类样本估算,运行中显示已用流量和预计总流量。启动前还可查看预计新增磁盘占用、抽帧临时文件和各盘剩余空间。媒体库设置可读取和保存 CloudDrive 的 API/数据代理,按对应目录的连接方式汇总流量;“代理保护”限制自动读取视频。统计范围与估算限制见[运行与配置](docs/OPERATIONS.md#配置页)。
「发送版本统计与错误诊断(推荐)」默认勾选,可在安装、首次设置或设置页取消。两类技术事件由同一开关控制,已保存的关闭选择会保留。启用后向 Sentry 发送页面列出的技术字段,不自动上传完整日志、诊断 ZIP、媒体信息或观看记录。见[远程诊断说明](docs/DIAGNOSTICS.md#可选远程诊断)。
@@ -137,7 +136,7 @@ macOS 可在本机构建独立 `.app` 与 DMG,内含 FFmpeg、ffprobe、untrun
## 问题反馈
-先查看[用户反馈](https://github.com/peach-mitao/peach/issues),或[提交问题](https://github.com/peach-mitao/peach/issues/new/choose),附上版本、操作步骤、预期与实际结果。截图请遮掉凭据、局域网地址和完整路径,不要上传数据库或媒体;安全问题按[安全政策](SECURITY.md)私下报告。
+先查看[用户反馈](https://github.com/peach-mitao/peach/issues),或[提交问题](https://github.com/peach-mitao/peach/issues/new/choose),附上版本、操作步骤、预期与实际结果。公开截图使用不含露骨画面的演示资料,遮掉凭据、局域网地址和完整路径,不要上传数据库或媒体;安全问题按[安全政策](SECURITY.md)私下报告。
## 文档
diff --git a/docs/README_MAINTENANCE.md b/docs/README_MAINTENANCE.md
index e10a7cc2c..d1c070e8a 100644
--- a/docs/README_MAINTENANCE.md
+++ b/docs/README_MAINTENANCE.md
@@ -53,7 +53,7 @@ README 改动必须核对两种语言;`updated` 至少对应一份实际差异
README、教程与网站的截图默认取自演示库。用分类模型从真实馆藏里筛「看起来无害」的帧不算
替代方案:筛出来的多是黑场与标题卡,卡片上的番号、姓名与厂牌照样泄露来源。
-公开 README 复用官网已发布的电影演示库截图,展示馆藏、人物、关注、统计与播放器;界面导览链接到官网 `#live`,仅嵌入已核对内容、来源和许可的视频。截图与文案明确区分演示数据、实际功能和影片访问权,保留成人内容年龄限制,不把外部来源的访问权说成 Peach 提供的能力。展示素材的来源、署名与许可链接到官网[素材来源与许可](https://peach.video/credits/),软件许可不替代第三方素材许可。
+公开 README 复用官网已发布的电影演示库截图,展示馆藏、人物、关注、统计与播放器;界面导览链接到官网 `#live`,仅嵌入已核对内容、来源和许可的视频。截图与文案明确区分演示数据、实际功能和影片访问权,保留来源的年龄、地区和访问限制,不把外部来源的访问权说成 Peach 提供的能力。展示素材的来源、署名与许可链接到官网[素材来源与许可](https://peach.video/credits/),软件许可不替代第三方素材许可。项目定位与公开附件边界见[文档规范](WRITING.md#公开与私有记录)。
公开画面不得出现访问凭据、局域网地址、隧道地址、文件系统完整路径或个人馆藏。截图由官网静态资源提供 WebP 展示图与无损 PNG 原图,README 的图片链接指向 PNG,避免 Release 附件的下载响应。WebP 展示图须小于 4 MB,并核验 GitHub 图片代理返回图片且浏览器完整解码;原图保持 3840×2160。更新链接时核对官网实际发布范围,不能只因本地文件存在就认为线上可用。截图不进仓库:`resources/` 会被整个打进安装包。仓库里确需
留存的少量演示媒体放 `docs/assets/`,单个文件压到 8 MB 以内(`tests/test_repo_hygiene.py`)。
diff --git a/docs/WRITING.md b/docs/WRITING.md
index 7d5d5e8af..b9f725358 100644
--- a/docs/WRITING.md
+++ b/docs/WRITING.md
@@ -21,6 +21,8 @@ README 保留开始使用所需的信息。字段定义放参考文档,操作
## 公开与私有记录
+- 项目介绍使用「影片刮削与媒体管理」定位,说明实际功能、访问条件与限制。来源名称、协议标识、依赖署名与许可证保持准确;通用介绍不以内容题材宣传产品。
+- README、网站、演示站、Release、issue、PR 与讨论区的截图、录屏和附件使用不含露骨画面的演示资料,保留来源、署名与许可记录;不发布个人馆藏画面或可直接播放的馆藏媒体。
- 本机交接、运行状态、个人待办、会话复盘、馆藏盘点和逐条复核记录保存到 `<Peach 数据目录>/state/project-context/`、`review/` 或 `archive/`,不进入 Git。
- 公开文档使用中性账号、`<项目目录>` 等占位路径与 RFC 5737 文档地址。主机名、网络布局、媒体文件名与馆藏数量不从真实部署复制。
- 公开参考证据保留来源、许可和复现方法;本机样本清单、原始日志与账号信息留在私有记录中。