Skip to content

Latest commit

 

History

History
115 lines (90 loc) · 6.12 KB

File metadata and controls

115 lines (90 loc) · 6.12 KB

RSS Can / RSS 罐头

CodeQL Build Artifacts Go Report Card codecov Docker Image

ENGLISH | 中文文档

📰 🥫 借助 AI 模型能力,做更好的 RSS 解决方案

支持软硬件环境

  • Linux: AMD64(x86_64)
  • macOS: AMD64(x86_64) / ARMv64

使用方法

从 GitHub 的软件发布页面,下载软件之后,直接运行就可以啦:

./rssc

Docker 容器方式运行

使用下面的命令,下载最新版本的软件之后,使用 docker run 运行即可(记得将项目中的 Feed Rules 挂载到容器中):

docker pull soulteary/rss-can:v0.3.8
docker run --rm -it -p 8080:8080 -v `pwd`/rules:/rules soulteary/rss-can:v0.3.8

支持的命令行参数及环境变量

所有的参数都是可选使用,根据自己的实际需要来即可。

想要获取程序支持的参数,可以通过在执行程序后添加参数 -h 或者 --help

Usage of rssc:
  -debug RSS_DEBUG
    	whether to output debugging logging, env: RSS_DEBUG
  -debug-level RSS_DEBUG_LEVEL
    	set debug log printing level, env: RSS_DEBUG_LEVEL (default "info")
  -feed-path RSS_HTTP_FEED_PATH
    	http feed path, env: RSS_HTTP_FEED_PATH (default "/feed")
  -headless-addr RSS_HEADLESS_SERVER
    	set Headless server address, env: RSS_HEADLESS_SERVER (default "127.0.0.1:9222")
  -headless-slow-motion RSS_HEADLESS_SLOW_MOTION
    	set Headless slow motion, env: RSS_HEADLESS_SLOW_MOTION (default 2)
  -host RSS_HOST
    	web service listening address, env: RSS_HOST (default "0.0.0.0")
  -memory RSS_MEMORY
    	using Memory(build-in) as a cache service, env: RSS_MEMORY (default true)
  -memory-expiration RSS_MEMORY_EXPIRATION
    	set Memory cache expiration, env: RSS_MEMORY_EXPIRATION (default 600)
  -port RSS_PORT
    	web service listening port, env: RSS_PORT (default 8080)
  -proxy RSS_PROXY
    	Proxy, env: RSS_PROXY
  -redis RSS_REDIS
    	using Redis as a cache service, env: RSS_REDIS (default true)
  -redis-addr RSS_SERVER
    	set Redis server address, env: RSS_SERVER (default "127.0.0.1:6379")
  -redis-db RSS_REDIS_DB
    	set Redis db, env: RSS_REDIS_DB
  -redis-pass RSS_REDIS_PASSWD
    	set Redis password, env: RSS_REDIS_PASSWD
  -rod string
    	Set the default value of options used by rod.
  -rule RSS_RULE
    	set Rule directory, env: RSS_RULE (default "./rules")
  -timeout-headless RSS_HEADLESS_EXEC_TIMEOUT
    	set headless execution timeout, env: RSS_HEADLESS_EXEC_TIMEOUT (default 5)
  -timeout-js RSS_JS_EXEC_TIMEOUT
    	set js sandbox code execution timeout, env: RSS_JS_EXEC_TIMEOUT (default 200)
  -timeout-request RSS_REQUEST_TIMEOUT
    	set request timeout, env: RSS_REQUEST_TIMEOUT (default 5)
  -timeout-server RSS_SERVER_TIMEOUT
    	set web server response timeout, env: RSS_SERVER_TIMEOUT (default 8)

里程碑

项目计划

  • 文档: 提供简单的教程和文档,阐述如何使用常见技术栈来玩转 RSS Can。 #16
  • Pipeline: 支持 RSS 信息流水线,能够定制信息处理任务,以及提供集成到各种开源软件的能力。
  • AI: NLP 任务的集成和使用。
  • 规则: 能够将社区两款软件的规则导入程序: rss-bridge / RSSHub
  • 工具: 支持通过界面工具快速生成规则,或参考: damoeb/rss-proxy

License & Credits

This project is licensed under the MIT License

项目的快速进化离不开下面优秀的开源软件,你可以点击这个链接,了解它们是谁:Credits