Spaces:
Paused
Paused
|
Download README.md from darkfire514/FreshRSS: direct link, hf CLI and curl.
- Browser
- Download file 6.53 kB
-
https://huggingface.co/spaces/darkfire514/FreshRSS/resolve/main/README.md
- Command line
-
hf download hf://spaces/darkfire514/FreshRSS/README.md
-
curl -L -o README.md https://huggingface.co/spaces/darkfire514/FreshRSS/resolve/main/README.md
6.53 kB
| title: WeRSS | |
| emoji: 📰 | |
| colorFrom: blue | |
| colorTo: indigo | |
| sdk: docker | |
| app_port: 7860 | |
| pinned: false | |
| license: mit | |
| # WeRSS · Hugging Face Docker | |
| 应用代码:[CaPaCaptain/WeRSS](https://github.com/CaPaCaptain/WeRSS),原始项目:[rachelos/we-mp-rss](https://github.com/rachelos/we-mp-rss)。 | |
| Space 根目录只放 **Dockerfile 和 README.md**。Dockerfile 在构建阶段拉取 GitHub 的 `main`,安装原版依赖、WebKit 和 Chromium,直接使用仓库已编译的 `static/` 前端。Python 文件和启动脚本均由 GitHub 仓库提供,不需要上传到 Space。 | |
| ## 部署步骤 | |
| 1. 创建或修改 Space,SDK 选择 **Docker**。 | |
| 2. 将 GitHub `huggingface/Dockerfile`、`huggingface/README.md` 上传至 Space 根目录,分别命名为 `Dockerfile`、`README.md`。 | |
| 3. 打开 **Settings → Variables and secrets**,配置下面的四项。 | |
| 4. 执行 **Factory rebuild**,等待 Build 完成并进入 Running。 | |
| 5. 打开应用,以 `USERNAME` 和 `PASSWORD` 登录。首次运行自动初始化数据库和管理员。 | |
| 6. 在应用的公众号授权或微信读书页面扫码,再添加订阅并测试刷新文章。 | |
| | 名称 | 配置类型 | 值或用途 | | |
| |---|---|---| | |
| | `GITHUB_TOKEN` | Secret | 当前私有 WeRSS 仓库的只读 GitHub PAT;构建时拉取代码 | | |
| | `USERNAME` | Variable | 初始管理员用户名,例如 `admin` | | |
| | `PASSWORD` | Secret | 初始管理员强密码 | | |
| | `SECRET_KEY` | Secret | 稳定的随机 JWT 密钥,可用 `openssl rand -base64 48` 生成 | | |
| GitHub PAT 建议使用 fine-grained Token,仅选择 `CaPaCaptain/WeRSS`,授予 **Contents: Read-only**。不要把 Token 写进 Dockerfile、README、公开 Variables 或仓库 URL。 | |
| 应用保留原版 **用户名 + 密码登录**。`GITHUB_TOKEN` 不是 OAuth Client Secret,也不用于登录应用。已有管理员的密码不会因为修改 Space 的 `PASSWORD` 而被重置,应在应用中修改密码。 | |
| ## 构建变量 | |
| 以下配置为 **Variable**,在 Docker 构建时作为 ARG 使用: | |
| | 名称 | 默认值 | 说明 | | |
| |---|---|---| | |
| | `REPO_URL` | `https://github.com/CaPaCaptain/WeRSS.git` | 应用源代码仓库,必须是 HTTPS GitHub 地址 | | |
| | `REPO_REF` | `main` | 分支、标签或 commit SHA | | |
| | `REBUILD_TAG` | `initial` | 修改此值可使 Git 拉取步骤重新执行 | | |
| `GITHUB_TOKEN` 通过 BuildKit Secret 挂载读取;临时 Authorization Header 只用于 GitHub,不写进 Git remote 或 Git 配置。运行应用前会清除它。 | |
| ## 运行变量 | |
| 以下配置也在 **Settings → Variables and secrets** 设置: | |
| | 名称 | 默认值 | 类型 | 用途 | | |
| |---|---|---|---| | |
| | `RSS_BASE_URL` | 空 | Variable | 建议设置为 `https://你的-space.hf.space/` | | |
| | `WEB_NAME` | 原版名称 | Variable | 页面显示名称 | | |
| | `ENABLE_JOB` | `True` | Variable | 启用原版定时任务 | | |
| | `WERSS_AUTH_WEB` | `False` | Variable | 保留原版授权方式配置 | | |
| | `MAX_PAGE` | `5` | Variable | 初次采集页数 | | |
| | `GATHER_MODEL` | `web` | Variable | 原版采集模式,包括 `web`、`api`、`app`、`weread` 等;以应用支持为准 | | |
| | `GATHER_CONTENT` | `False` | Variable | 是否保存文章正文 | | |
| | `GATHER_CONTENT_AUTO_CHECK` | `True` | Variable | 自动检查未采集正文 | | |
| | `DB` | `sqlite:////data/db.db` | Secret | 可选:外部 SQLAlchemy 数据库连接字符串 | | |
| | `PROXY_ENABLED` | `False` | Variable | 启用原版代理配置 | | |
| | `PROXY_HTTP_URL` | 空 | Secret | 代理地址,可能包含密码 | | |
| | `REDIS_SERVER_PASSWORD` | 空 | Secret | 内置 Redis 密码,可选 | | |
| | `DINGDING_WEBHOOK` / `WECHAT_WEBHOOK` / `FEISHU_WEBHOOK` / `CUSTOM_WEBHOOK` | 空 | Secret | 可选通知渠道 | | |
| 模板已配置 `PORT=7860`、`THREADS=1`、`AUTO_RELOAD=False`、Xvfb、WebKit 和 Chromium,一般不需要修改。`PORT` 必须与此 README 的 `app_port` 一致。 | |
| 原版点号环境变量仍然有效;Space 可使用下划线别名,例如 `GATHER_CONTENT` 对应 `GATHER.CONTENT`、`CACHE_DIR` 对应 `CACHE.DIR`。无需修改或在构建中修补配置文件。 | |
| ## 数据保存 | |
| 启动时映射: | |
| ```text | |
| /app/data → /data | |
| /app/config.yaml → /data/config.yaml | |
| ``` | |
| `/data` 保存 SQLite、授权状态、浏览器 profile、缓存、配置和导出文件。已有 `config.yaml` 不会在重启或重建时被覆盖。容器按 Hugging Face 的 UID `1000` 运行,挂载目录须允许该用户写入。 | |
| **目录名 `/data` 本身不保证持久化。** 未配置持久存储时,重启或重建可能丢失数据。请按 Space 实际支持的存储类型配置;存储桶挂载须单独确认数据库文件锁和原子操作支持,不能仅因挂载成功就认定适合 SQLite。正式使用可选择可从 Space 连接的外部 PostgreSQL/MySQL,同时持久保存授权与 profile 文件。 | |
| 原版 `DB` 接受 SQLAlchemy DSN,例如 `postgresql://user:password@host/database`。General PostgreSQL 的 HTTPS Data API 地址不能直接填进此字段;当前原版部署没有新增 Data API 适配。 | |
| ## 更新应用 | |
| 本 Space 在 **构建时**读取 GitHub,不会自动监听 GitHub main 的变化: | |
| 1. 更新/合并 WeRSS GitHub 仓库的 `main`。 | |
| 2. 在 Space 执行 **Factory rebuild**,或修改 `REBUILD_TAG` 后重新构建。 | |
| 3. Build 日志里的 checkout 信息可确认拉取版本;镜像内 `/app/docker_revision.txt` 记录 commit。 | |
| 只有普通 Restart 不会重新拉取代码。若修改了 GitHub 的 `huggingface/Dockerfile` 或此 README,还需把对应文件重新上传到 Space。 | |
| ## 验证与排查 | |
| 运行成功后,首页应显示原版界面,`/api/docs` 提供 Swagger,`/api/openapi.json` 提供接口定义。登录后测试:公众号授权、添加订阅、文章刷新、RSS,以及需要的微信读书功能。 | |
| - Git 拉取报 401/404:检查 `GITHUB_TOKEN` 是否能读取私有 WeRSS 仓库及 `REPO_REF` 是否存在。 | |
| - 日志提示数据目录不可写:修正挂载目录对 UID `1000` 的权限。 | |
| - 登录失败:确认初始用户名/密码;已有数据库使用已有密码。 | |
| - 运行版本未更新:执行 Factory rebuild,而非 Restart。 | |
| - 扫码成功但没有文章:检查原版授权状态、采集模式和微信接口返回;构建成功不代表微信接口可用。 | |
| 免费 Space 休眠时,进程内定时任务也会暂停。微信接口仍可能受授权过期、出口 IP 和风控影响。 | |
| 官方部署文档:[Docker Spaces](https://huggingface.co/docs/hub/spaces-sdks-docker)。 | |