https://github.com/Colin-XKL/RSSmanX

RSSman X 一套综合RSS解决方案
https://github.com/Colin-XKL/RSSmanX

docker feed proxy rss rsshub selfhost

Last synced: 18 days ago
JSON representation

RSSman X 一套综合RSS解决方案

• Host: GitHub
• URL: https://github.com/Colin-XKL/RSSmanX
• Owner: Colin-XKL
• License: gpl-3.0
• Created: 2020-07-07T14:33:38.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-16T15:16:21.000Z (5 months ago)
• Last Synced: 2024-11-16T16:24:07.073Z (5 months ago)
• Topics: docker, feed, proxy, rss, rsshub, selfhost
• Homepage: https://github.com/Colin-XKL/RSSmanX
• Size: 205 KB
• Stars: 122
• Watchers: 3
• Forks: 10
• Open Issues: 9
• Metadata Files:
  • Readme: README-zh_cn.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RSSman X

![logo](./.github/logo.png)

![author](https://img.shields.io/badge/author-Colin-blue)

![license](https://img.shields.io/github/license/Colin-XKL/RSSmanX)

![release](https://img.shields.io/github/v/release/Colin-XKL/RSSmanX)

![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FColin-XKL%2FRSSmanX.svg?type=shield)

[RSSman X](https://github.com/Colin-XKL/RSSmanX) 基于 docker-compose 提供容器化 TTRSS 与 RSSHUB 等组件的一键部署，整合实用组件为你带来最佳 RSS 体验

**Feature： 简单一键部署，常用组件支持，自动更新支持，服务健康自检支持，海外站点 RSS 解锁**

# 说明

本项目旨在为 RSS 的同好提供一个方便地搭建自己的 RSS 服务的捷径。毕竟不是所有 RSS 爱好者都懂代码 😂。如果你想快速地搭建自己的 RSS 服务，能够有 RSS 订阅管理、RSS 在线阅读界面，进阶功能包括服务健康自检、海外站点 RSS 解锁等。希望订阅国内外的各大网站的 RSS 信息源又不想跟着网上漫天飞的教程瞎折腾的话，那么你可以使用本仓库的脚本快速完成安装部署。

### 不同版本中包含的组件说明

三个版本的`docker-compose`文件对应不同的需求，包含的组件和服务有差异, 上手和维护复杂度也不同, 请根据需要选择.

对于有一定基础的用户, 建议优先选择ultimate版本, 功能最全面, 更新也最多

| **组件名**      | **说明**                                       | **Lite 版** | **标准版** | **Ultimate 版 ✨** |

| --------------- | ---------------------------------------------- | ----------- | ---------- | ----------------- |

| **TTRSS**       | RSS阅读、管理                                  | ✅           | ✅          | ✅                 |

| **RSSHub**      | 为各种网站添加RSS支持                          | ✅           | ✅          | ✅                 |

| **Huginn**      | 强大的IFTTT工具,可以用来为任意网站生成RSS      |             |            | ✅                 |

| **Mercury**     | TTRSS插件组件,用于提取全文                     |             | ✅          | ✅                 |

| **OpenCC**      | TTRSS插件组件,用于简繁中文转换                 |             |            | ✅                 |

| **Redis**       | 附加组件,缓存内容                              |             | ✅          | ✅                 |

| **Browserless** | 附加组件,模拟浏览器抓取网页                    |             |            | ✅                 |

| **WEWE-RSS**    | 将微信公众号转换为RSS                          |             |            | ✅                 |

| **FeedCraft**   | 强大的RSS处理工具,可以支持AI摘要、翻译、聚合等 |             |            | ✅                 |

其他一些特性:

| **特性**                   | **Lite 版** | **标准版** | **Ultimate 版 ✨** |

| -------------------------- | ----------- | ---------- | ----------------- |

| **数据持久化保存**         | ✅           | ✅          | ✅                 |

| **容器自动更新**           |             | ✅          | ✅                 |

| **容器健康检查**           |             | ✅          | ✅                 |

| **海外站点加速**           |             |            | ✅                 |

| **智能路由**               |             |            | ✅                 |

| **反反爬虫**               |             |            | ✅                 |

| **开箱即用的公益代理配置** |             |            | ✅                 |

不同组件的功能描述见文末。不同版本对应的文件夹如下：

**标准版：** `rssman-standard`

**Lite 版：** `rssman-lite`

**Ultimate 版：** `rssman-ultimate`

确定好要使用的版本, 填写好`.env`文件中的变量,如服务器地址和数据库密码等, 使用`sudo docker compose up -d`命令即可快速部署

(注`.env`文件这种以点开头的文件,在linux中默认是隐藏的, 需要使用`ls -a`才会显示)

# 安装说明

详细docker组件安装和其他部署细节可以参见[RSSManX 安装部署指南](https://blog.colinx.one/posts/rssmanx%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97/)

## 需求

- 一台 Linux 系统的服务器

  > 本文以 Ubuntu 18.04 系统的服务器为例，其他系统如 CentOS 的会有点差异, 此处不再赘述

## 依赖项

- docker

- docker-compose

**安装 Docker**

```bash

sudo apt-get update

sudo apt-get install apt-transport-https ca-certificates curl gnupg-agent software-properties-common

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo

sudo add-apt-repository \

   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \

   $(lsb_release -cs) \

   stable"

sudo apt-get update

sudo apt-get install docker-ce docker-ce-cli containerd.io

```

**安装 docker-compose**

```bash

sudo apt install docker-compose

```

完整文档参见 📕

- https://docs.docker.com/engine/install/

- https://docs.docker.com/compose/install/

## 如何安装

安装好了 `docker` 和 `docker-compose` 后，可以使用`git clone https://github.com/Colin-XKL/RSSmanX --depth=1`快速克隆本仓库，也可以通过[这个镜像地址](https://archive.fastgit.org/Colin-XKL/RSSmanX/archive/refs/heads/master.zip)下载仓库zip文件

1. cd 进入文件夹，修改.env中的值，如密码和TTRSS入口URL等

2. 选择一个你需要安装的RSS MAN X的版本，如安装ultimate版，进入需要根据需要填写好`.env`文件中的变量

3. 运行 `sudo docker-compose up -d`

4. 等待程序跑完

5. 安装完成 ✅

#### 使用相关事宜：

1. 访问你设置的`SELF_URL`即可看到 Tiny Tiny RSS 的登陆页面，使用默认账户`admin`，密码`password`登陆即可开始使用。

2. 如开启海外站点解锁支持，第一次冷启动需要等待 3-5 分钟才能完全启动所有组件。

3. 默认数据保存位置 `~/.dockerData/Database/`, 你可以在`.env`文件中更改

4. 在TTRSS中将原来订阅的 `https://rsshub.app/*` 更改为 `http://rsshub/*` 即可使用RSSMan内的自建RSSHub实例，并激活反反爬虫和海外源加速等功能

5. 关于ARM平台的支持可查阅置顶的issue

6. 默认情况下只有TTRSS和Huginn可以从外部访问，其他组件互相可以访问但不能直接从外部访问以提高安全性

7. RSS Man X的自托管的 mercury 实例，你只需要在TTRSS插件配置页面设置 mercury 实例地址为 `service.mercury:3000` 即可，同理，OpenCC实例地址为`service.opencc:3000`  

其他常见问题和部署使用细节可以查阅Github Issue或[RSSManX 安装部署指南](https://blog.colinx.one/posts/rssmanx%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97/)  

详细配置和使用事宜请参考对应应用的文档说明。

- TTRSS 相关文档 [https://ttrss.henry.wang/](https://ttrss.henry.wang/)

- RSSHub 相关文档 [https://docs.rsshub.app/](https://docs.rsshub.app/)

## 功能模块介绍

**Tiny Tiny RSS**

RSS 订阅管理与在线阅读工具

**RSShub**

生成国内大部分网站的 RSS 信息源，同时自部署可以访问到那些严格防爬的站点的源（知乎、微博等）

使用文档: https://docs.rsshub.app

官方链接无法访问的话也可以使用我维护的镜像文档站点: https://rsshub-doc.azure.colinx.one/zh/guide/

**Huginn**

高级 IFTTT 工具，你可以用生成任何 RSS 源，但使用门槛略高，可参考这篇教程 [Huginn 指南：为任意网站制作 RSS

](https://blog.colinx.one/posts/huginn%E6%8C%87%E5%8D%97%E4%B8%BA%E4%BB%BB%E6%84%8F%E7%BD%91%E7%AB%99%E5%88%B6%E4%BD%9Crss/)

**Postgres**

数据库，用于存储 RSS 文章数据等。比 MySQL 更轻，性能更好

**OpenCC**

简繁体转换，如果你订阅了一些繁体的 RSS 源，可以用它来将文章转为简体

**Mercury**

用于获取 RSS 全文

**Browserless**

用于获取常规方式无法获取的网站 RSS，为 RSSHub 的可选组件

**Redis**

提供缓存，提升性能，为 RSSHub 的可选组件

**WatchTower**

用于自动更新 RSShub 等组件，可以更好地支持新添加的源以及更快的获得 bug 修复

**Clash**

智能路由与正向代理工具，用于解锁海外站点及提供海外 RSS 源的加速

**WEWE RSS**

通过微信读书的接口获取公众号内容来生成RSS. 相对于其他爬虫形式的方案更加稳定.

**FeedCraft**

强大的RSS处理工具, 支持对RSS进行AI摘要, 翻译, 聚合等. 兼容现有的任何RSS阅读器和工具.

# 建议配置

建议使用至少1c1g的Linux x86服务器以获得更好的体验

rssman-lite: 256M内存  

rssman-standard: 256M内存  

rssman-ultimate: 1G内存, 建议预留1.5-2G内存以获得更好体验  

# Acknowledgement

- [Tiny tiny RSS](https://tt-rss.org/)

- [OpenCC](https://github.com/BYVoid/OpenCC)

- [Mercury](https://github.com/postlight/mercury-parser)

- [Huginn](https://github.com/huginn/huginn)

- [RSShub](https://github.com/DIYgod/RSSHub)

- [Awesome TTRSS](https://github.com/HenryQW/Awesome-TTRSS)

# License

GPL-3.0

# Changelogs

- 2020-07-07 v1.0 首次发布

- 2020-07-14 v1.1 更新快速启动脚本

- 2020-10-05 v1.2 修复错误的环境变量

- 2020-11-08 v1.3 TTRSS 现在可以使用除 80/443 以外的端口更新订阅，且自托管 rsshub 再次可用

- 2020-11-13 v1.4 多项更新，包括安全性和性能增强

- 2020-11-24 v1.5 锁定某些服务的 Docker 镜像版本，以避免意外错误

- 2021-05-08 v2.0 添加容器网络隔离、健康检查、全局代理、智能路由等功能

- 2021-05-10 v2.1 添加反反爬虫、Cloudflare 等的规则

- 2021-06-15 v2.5 更新路由规则，改进容器重启策略

- 2021-08-14 v2.6 优化路由规则

- 2022-05-08 v3.1 使用 .env 文件设置变量，更新路由配置等

- 2022-05-11 v3.3 修复在 NAS 上部署 Huginn 时的一些问题，更新一些默认配置

- 2023-12-11 v4.0 重构 Compose YAML 文件，使其更清晰易用

- 2024-11-16 v4.3 添加wewe-rss, feed-craft, 以及clash的继任者. 更新默认的公益代理配置