RSSHub Documentation

TypeScript bilibili & douban repository by @DIYgod. AI agent rules & system prompts with 46k stars.

45,726 stars TypeScript TypeScript 1 file · ~1,533 tokens #bilibili#douban#dribbble#instagram#lofter#pixiv#rss#rsshub
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy RSSHub on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name rsshub -p 1200:1200 --restart always diygod/rsshub
Configured Services & Ports
⚙️ rsshub
image: diygod/rsshub
🔌 Ports: 1200:1200
⚙️ browserless
image: ghcr.io/browserless/chromium
⚙️ redis
image: redis:alpine
docker-compose.yml
yaml (docker-compose.yml) 
services:
    rsshub:
        # two ways to enable Playwright:
        # * comment out marked lines, then use this image instead: diygod/rsshub:chromium-bundled
        # * (consumes more disk space and memory) leave everything unchanged
        image: diygod/rsshub # or ghcr.io/diygod/rsshub
        restart: always
        ports:
            - '1200:1200'
        environment:
            NODE_ENV: production
            CACHE_TYPE: redis
            REDIS_URL: 'redis://redis:6379/'
            PLAYWRIGHT_CDP_ENDPOINT: 'ws://browserless:3000?token=${BROWSERLESS_TOKEN:-rsshub}' # marked
        healthcheck:
            test: ['CMD', 'curl', '-f', 'http://localhost:1200/healthz']
            interval: 30s
            timeout: 10s
            retries: 3
        depends_on:
            - redis
            - browserless # marked

    browserless: # marked
        image: ghcr.io/browserless/chromium # marked
        restart: always # marked
        environment: # marked
            TOKEN: '${BROWSERLESS_TOKEN:-rsshub}' # marked
        ulimits: # marked
            core: # marked
                hard: 0 # marked
                soft: 0 # marked
        healthcheck: # marked
            test: ['CMD-SHELL', 'curl -f "http://localhost:3000/pressure?token=$$TOKEN"'] # marked
            interval: 30s # marked
            timeout: 10s # marked
            retries: 3 # marked

    redis:
        image: redis:alpine
        restart: always
        volumes:
            - redis-data:/data
        healthcheck:
            test: ['CMD', 'redis-cli', 'ping']
            interval: 30s
            timeout: 10s
            retries: 5
            start_period: 5s

volumes:
    redis-data:

1. Project Overview & Quickstart (DIYgod/RSSHub)

File: README.md

RSSHub

🧡 Everything is RSSible






|

RSSHub pairs especially well with Folo, an AI RSS reader for feed discovery and modern reading workflows. The project is also open source on GitHub.

Introduction

RSSHub is the world's largest RSS network, consisting of over 5,000 global instances.

RSSHub delivers millions of contents aggregated from all kinds of sources, our vibrant open source community is ensuring the deliver of RSSHub's new routes, new features and bug fixes.

Documentation | Folo | Telegram Group | Telegram Channel | X (Twitter)

  • Folo | An AI RSS reader that works especially well with RSSHub. Source code: GitHub.
  • RSSHub Radar | A browser extension that can help you quickly discover and subscribe to the RSS and RSSHub of current websites.
  • RSSBud | RSSHub Radar for iOS platform, designed specifically for mobile ecosystem optimization.
  • RSSAid | RSSHub Radar for Android platform built with Flutter.
  • DocSearch | Link RSSHub DocSearch into Raycast.
  • Awesome RSSHub Routes | Curated list of RSS feeds and RSSHub routes.

Contribute

We welcome all pull requests. Suggestions and feedback are also welcomed here.

Refer to Quick Start

Deployment

Refer to Deployment

Special Thanks

Author

RSSHub © DIYgod, Released under the AGPL-3.0 License.
Authored and maintained by DIYgod with help from contributors (list).

Blog @DIYgod · GitHub @DIYgod · X (Twitter) @DIYgod · Telegram Channel @awesomeDIYgod

File: scripts/ansible/README.md

Readme

Ansible playbook to deploy RSSHub on bare-metal with Redis, browserless and Caddy 2

Requires sudo permission

Usage

On Ubuntu 20.04, install ansible, then

bash
sudo ansible-playbook rsshub.yaml

Development

Install vagrant, then

bash
./try.sh
ansible-playbook rsshub.yaml

2. Official Technical Reference & Guides (DIYgod/DIYgod.github.io)

A Diary Generator

Reads diaries written in markdown from a git submodule, and generates a static site for it. (Demo)

About the repos

The markdown files for the diaries can be kept under another repo named YYYY/MM/DDDD.md(Example).

Build

  1. Run npm install to install the dependencies
  2. Configure config.js
  3. git checkout -b yourname for your own branch(so you can keep the master branch intact in case you want to receive updates)
  4. git rm diary to remove the old submodule for diaries
  5. git submodule add git://new/submodule.git diary to add your own submodule
  6. Commit the changes (to your own branch) if you want.
  7. Run gulp build to generate the static site (placed under dist).
  8. Run gulp server and visit http://localhost:8000/diary if you want to see it hosted locally(make sure the port 8000 is not taken).

You can receive updates by pulling updates into your master branch, and check them out to your own branch.

Deploy to GitHub Pages

  1. Set up the SSH git remote origin for the project.
  2. After building the web page, run gulp deploy.
  3. Everything under dist will be pushed to the remote repo's gh-pages branch.

Develop

  1. Make sure port 35729(for livereload) and 8000(for the local server) are available.
  2. Run gulp, then visit http://localhost:8000/diary.
  3. Start development!
  4. When you are done, you can checkout the changes from your branch to the master branch, and send in a pull request if you want.

TODO

  • Write a calendar to replace pikaday
  • Add "previous" and "next" button to the diary pages

LICENSE

(MIT License)

Copyright (c) 2015 Joyee Cheung

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#bilibili Browse bilibili catalog → #douban Browse douban catalog → #dribbble Browse dribbble catalog → #instagram Browse instagram catalog → #lofter Browse lofter catalog → #pixiv Browse pixiv catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →