RSS Can / RSS 罐头

ENGLISH | 中文文档

📰 🥫 Got RSS CAN be better and simple.

Supported Systems and Architectures

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

Usage

Download the binary from the github release page, with the following command:

./rssc

Docker

Pull the docker image and mount the Feed rules file in the project to the docker container:

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

Cli Parameters & Environment

All parameters are optional, please adjust according to your needs

The parameters supported by the program can be obtained through -h or --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)

PLAN

• 2022.12.22 Support parameters call, release v0.2.0; Support simple web UI, and new parameters, release version v0.3.0.

• 2022.12.21 Support aggregate results across multiple pages, complete the first version of the JS SDK, release v0.1.0 and Docker images.

• 2022.12.20 Support Redis, in-memory caching to avoid sending meaningless requests, dynamic loading rules.

• 2022.12.19 Support document charset auto detection, MIX parser, both use CSR and SSR parser, faster batch CSR processing, Extract combined data from detail pages and assemble detailed RSS feed data.

• 2022.12.15 Websites parsing via CSR render, Blog

• 2022.12.14 Convert website page as RSS feeds, Blog

• 2022.12.13 Dynamic rule capability, Blog

• 2022.12.12 Websites parsing via SSR render, Blog

• Docs: Provide a simple tutorial on how to use Docker images with common technology stacks

• Golang: Optimized for Golang 1.19

• Pipeline: Support RSS pipeline flow, customize information processing tasks and integrate other open-source software

• AI: NLP tasks

• Rules: Support merge open-source software rules: rss-bridge / RSSHub

• Tools: Quick RSS rules generator, like: damoeb/rss-proxy

License & Credits

This project is licensed under the MIT License

The rapid evolution of the project is inseparable from the following excellent open source software, you can click this link to know who they are : Credits